statelydb 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acc7d4cbc70b66408fc0723cb627b291114ea531eabf57491d668bd4be9c6dc6
-  data.tar.gz: 4758fd8040faca40481b98aa713c12f711c353cbdfc2141e604227276da59e9c
+  metadata.gz: 1f23ab192f6828001354306b8ad34133ec3d2ffd190b984317b21cdd37f13260
+  data.tar.gz: 4748c4cb64afcec1ae6855b13eb77431686c5969519676ba76b312e13af328c6
 SHA512:
-  metadata.gz: 9338ba66b860a68ba965534743dc9f119c19d7db3196432f003db98d056a2ac33f4ce600064200b44e61d355750bc1c2ff1ac1fe378ac0618c5716aea19de8f0
-  data.tar.gz: 44c1c821cde2adc873cb223b3459744959dbe4ab625ddf9da76a9f47e7662cdcd028a6a471f0243fdefea30c419e1e8c8c28c251c776b66b8c8168675dbc27c9
+  metadata.gz: b0fa966836be47eaa591ab5d88b10107471a28b0d4b05f4fb34d655a14826ae77f11bcf45096eb40c9c90acfdf4aba8b1c78cc849340fae79afd230608635812
+  data.tar.gz: 5911f73934190cbd9bdb415241f332bd740a4e073bbde7b2bb5f4a7fc8e91fcaccf18f246a3633be8d4401065f777a75a88243f8126b628163737b2f5bb3e070

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Stately Cloud, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -8,13 +8,6 @@ This is the Ruby SDK for [StatelyDB](https://stately.cloud).
 
 We're still in an invite-only preview mode - if you're interested, please reach out to [preview@stately.cloud](mailto:preview@stately.cloud?subject=Early%20Access%20Program).
 
-When you join the preview program, we'll set you up with a few bits of information:
-
-1. `STATELY_CLIENT_ID` - a client identifier so we know what client you are.
-2. `STATELY_CLIENT_SECRET` - a sensitive secret that lets your applications authenticate with the API.
-3. A store ID that identifies which store in your organization you're using.
-4. Access to our in-depth [Getting Started Guide].
-
 Begin by following our [Getting Started Guide] which will help you define, generate, and publish a DB schema so that it can be used.
 
 ##### Install the SDK
@@ -32,8 +25,8 @@ Create an authenticated client, then import your item types from your generated
 require_relative 'schema/stately'
 
 def put_my_item
-    # Create a client. This will use the environment variables
-    # STATELY_CLIENT_ID and STATELY_CLIENT_SECRET for your client.
+    # Create a client. This will use the environment variable
+    # STATELY_ACCESS_KEY to read your access key
     client = StatelyDB::Client.new(store_id: <my-store-id>)
 
     # Instantiate an item from your schema

data/lib/common/auth/auth_token_provider.rb

@@ -24,17 +24,16 @@ module StatelyDB
       # It will default to using the value of `STATELY_ACCESS_KEY` if
       # no credentials are explicitly passed and will throw an error if no credentials are found.
       class AuthTokenProvider < TokenProvider
-        # @param [String] origin The origin of the auth server
+        # @param [String] endpoint The endpoint of the auth server
         # @param [String] access_key The StatelyDB access key credential
         # @param [Float] base_retry_backoff_secs The base retry backoff in seconds
         def initialize(
-          origin: "https://api.stately.cloud",
+          endpoint: "https://api.stately.cloud",
           access_key: ENV.fetch("STATELY_ACCESS_KEY", nil),
           base_retry_backoff_secs: 1
         )
           super()
-          @actor = Async::Actor.new(Actor.new(origin: origin, access_key: access_key,
-                                              base_retry_backoff_secs: base_retry_backoff_secs))
+          @actor = Async::Actor.new(Actor.new(endpoint:, access_key:, base_retry_backoff_secs:))
           # this initialization cannot happen in the constructor because it is async and must run on the event loop
           # which is not available in the constructor
           @actor.init
@@ -55,10 +54,10 @@ module StatelyDB
         # Actor for managing the token refresh
         # This is designed to be used with Async::Actor and run on a dedicated thread.
         class Actor
-          # @param [String] origin The origin of the OAuth server
+          # @param [String] endpoint The endpoint of the OAuth server
           # @param [String] access_key The StatelyDB access key credential
           # @param [Float] base_retry_backoff_secs The base retry backoff in seconds
-          def initialize(origin:, access_key:, base_retry_backoff_secs:)
+          def initialize(endpoint:, access_key:, base_retry_backoff_secs:)
             super()
 
             if access_key.nil?
@@ -72,7 +71,7 @@ module StatelyDB
             end
 
             @token_fetcher = StatelyDB::Common::Auth::StatelyAccessTokenFetcher.new(
-              origin: origin,
+              endpoint: endpoint,
               access_key: access_key,
               base_retry_backoff_secs: base_retry_backoff_secs
             )

data/lib/common/auth/token_fetcher.rb

@@ -48,14 +48,14 @@ module StatelyDB
         ].freeze
         RETRY_ATTEMPTS = 10
 
-        # @param [String] origin The origin of the OAuth server
+        # @param [String] endpoint The endpoint of the OAuth server
         # @param [String] access_key The StatelyDB access key credential
         # @param [Float] base_retry_backoff_secs The base backoff time in seconds
-        def initialize(origin:, access_key:, base_retry_backoff_secs:)
+        def initialize(endpoint:, access_key:, base_retry_backoff_secs:)
           super()
           @access_key = access_key
           @base_retry_backoff_secs = base_retry_backoff_secs
-          @channel = Common::Net.new_channel(endpoint: origin)
+          @channel = Common::Net.new_channel(endpoint:)
           error_interceptor = Common::ErrorInterceptor.new
           @stub = Stately::Auth::AuthService::Stub.new(nil, nil, channel_override: @channel,
                                                                  interceptors: [error_interceptor])

data/lib/key_path.rb

@@ -58,7 +58,7 @@ module StatelyDB
         [value].pack("m0").tr("=", "").tr("+/", "-_")
       else
         # Any other value is just converted to a string
-        value.to_s
+        value.to_s.gsub("/", "%/")
       end
     end
   end

data/lib/statelydb.rb

@@ -28,11 +28,14 @@ module StatelyDB
     # @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.
+    # @param no_auth [Boolean] Indicates that the client should not attempt to get
+    #     an auth token. This is used when talking to the Stately BYOC Data Plane on localhost.
     def initialize(store_id:,
                    schema:,
                    token_provider: Common::Auth::AuthTokenProvider.new,
                    endpoint: nil,
-                   region: nil)
+                   region: nil,
+                   no_auth: false)
       if store_id.nil?
         raise StatelyDB::Error.new("store_id is required",
                                    code: GRPC::Core::StatusCodes::INVALID_ARGUMENT,
@@ -46,13 +49,14 @@ module StatelyDB
 
       endpoint = self.class.make_endpoint(endpoint:, region:)
       @channel = Common::Net.new_channel(endpoint:)
-      @token_provider = token_provider
+      # Make sure to use the correct endpoint for the default token provider
+      @token_provider = token_provider || Common::Auth::AuthTokenProvider.new(endpoint:)
 
-      auth_interceptor = Common::Auth::Interceptor.new(token_provider:)
-      error_interceptor = Common::ErrorInterceptor.new
+      interceptors = [Common::ErrorInterceptor.new]
+      interceptors << Common::Auth::Interceptor.new(token_provider:) unless no_auth
 
-      @stub = Stately::Db::DatabaseService::Stub.new(nil, nil, channel_override: @channel,
-                                                               interceptors: [error_interceptor, auth_interceptor])
+      @stub = Stately::Db::DatabaseService::Stub.new(nil, nil,
+                                                     channel_override: @channel, interceptors:)
       @store_id = store_id.to_i
       @schema = schema
       @allow_stale = false

data/sig/statelydb.rbi

@@ -204,16 +204,19 @@ module StatelyDB
     # _@param_ `endpoint` — the endpoint to connect to.
     # 
     # _@param_ `region` — the region to connect to.
+    # 
+    # _@param_ `no_auth` — Indicates that the client should not attempt to get an auth token. This is used when talking to the Stately BYOC Data Plane on localhost.
     sig do
       params(
         store_id: Integer,
         schema: Module,
         token_provider: Common::Auth::TokenProvider,
         endpoint: T.nilable(String),
-        region: T.nilable(String)
+        region: T.nilable(String),
+        no_auth: T::Boolean
       ).void
     end
-    def initialize(store_id:, schema:, token_provider: Common::Auth::AuthTokenProvider.new, endpoint: nil, region: nil); end
+    def initialize(store_id:, schema:, token_provider: Common::Auth::AuthTokenProvider.new, endpoint: nil, region: nil, no_auth: false); end
 
     # _@return_ — nil
     sig { void }
@@ -618,13 +621,13 @@ module StatelyDB
 ].freeze, T.untyped)
         RETRY_ATTEMPTS = T.let(10, T.untyped)
 
-        # _@param_ `origin` — The origin of the OAuth server
+        # _@param_ `endpoint` — The endpoint of the OAuth server
         # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base backoff time in seconds
-        sig { params(origin: String, access_key: String, base_retry_backoff_secs: Float).void }
-        def initialize(origin:, access_key:, base_retry_backoff_secs:); end
+        sig { params(endpoint: String, access_key: String, base_retry_backoff_secs: Float).void }
+        def initialize(endpoint:, access_key:, base_retry_backoff_secs:); end
 
         # Fetch a new token from the StatelyDB API
         # 
@@ -665,13 +668,13 @@ module StatelyDB
       # It will default to using the value of `STATELY_ACCESS_KEY` if
       # no credentials are explicitly passed and will throw an error if no credentials are found.
       class AuthTokenProvider < StatelyDB::Common::Auth::TokenProvider
-        # _@param_ `origin` — The origin of the auth server
+        # _@param_ `endpoint` — The endpoint of the auth server
         # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-        sig { params(origin: String, access_key: String, base_retry_backoff_secs: Float).void }
-        def initialize(origin: "https://api.stately.cloud", access_key: ENV.fetch("STATELY_ACCESS_KEY", nil), base_retry_backoff_secs: 1); end
+        sig { params(endpoint: String, access_key: String, base_retry_backoff_secs: Float).void }
+        def initialize(endpoint: "https://api.stately.cloud", access_key: ENV.fetch("STATELY_ACCESS_KEY", nil), base_retry_backoff_secs: 1); end
 
         # Close the token provider and kill any background operations
         # This just invokes the close method on the actor which should do the cleanup
@@ -687,13 +690,13 @@ module StatelyDB
         # Actor for managing the token refresh
         # This is designed to be used with Async::Actor and run on a dedicated thread.
         class Actor
-          # _@param_ `origin` — The origin of the OAuth server
+          # _@param_ `endpoint` — The endpoint of the OAuth server
           # 
           # _@param_ `access_key` — The StatelyDB access key credential
           # 
           # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-          sig { params(origin: String, access_key: String, base_retry_backoff_secs: Float).void }
-          def initialize(origin:, access_key:, base_retry_backoff_secs:); end
+          sig { params(endpoint: String, access_key: String, base_retry_backoff_secs: Float).void }
+          def initialize(endpoint:, access_key:, base_retry_backoff_secs:); end
 
           # Initialize the actor. This runs on the actor thread which means
           # we can dispatch async operations here.

data/sig/statelydb.rbs

@@ -170,12 +170,15 @@ module StatelyDB
     # _@param_ `endpoint` — the endpoint to connect to.
     # 
     # _@param_ `region` — the region to connect to.
+    # 
+    # _@param_ `no_auth` — Indicates that the client should not attempt to get an auth token. This is used when talking to the Stately BYOC Data Plane on localhost.
     def initialize: (
                       store_id: Integer,
                       schema: Module,
                       ?token_provider: Common::Auth::TokenProvider,
                       ?endpoint: String?,
-                      ?region: String?
+                      ?region: String?,
+                      ?no_auth: bool
                     ) -> void
 
     # _@return_ — nil
@@ -531,12 +534,12 @@ module StatelyDB
         NON_RETRYABLE_ERRORS: untyped
         RETRY_ATTEMPTS: untyped
 
-        # _@param_ `origin` — The origin of the OAuth server
+        # _@param_ `endpoint` — The endpoint of the OAuth server
         # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base backoff time in seconds
-        def initialize: (origin: String, access_key: String, base_retry_backoff_secs: Float) -> void
+        def initialize: (endpoint: String, access_key: String, base_retry_backoff_secs: Float) -> void
 
         # Fetch a new token from the StatelyDB API
         # 
@@ -572,12 +575,12 @@ module StatelyDB
       # It will default to using the value of `STATELY_ACCESS_KEY` if
       # no credentials are explicitly passed and will throw an error if no credentials are found.
       class AuthTokenProvider < StatelyDB::Common::Auth::TokenProvider
-        # _@param_ `origin` — The origin of the auth server
+        # _@param_ `endpoint` — The endpoint of the auth server
         # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-        def initialize: (?origin: String, ?access_key: String, ?base_retry_backoff_secs: Float) -> void
+        def initialize: (?endpoint: String, ?access_key: String, ?base_retry_backoff_secs: Float) -> void
 
         # Close the token provider and kill any background operations
         # This just invokes the close method on the actor which should do the cleanup
@@ -591,12 +594,12 @@ module StatelyDB
         # Actor for managing the token refresh
         # This is designed to be used with Async::Actor and run on a dedicated thread.
         class Actor
-          # _@param_ `origin` — The origin of the OAuth server
+          # _@param_ `endpoint` — The endpoint of the OAuth server
           # 
           # _@param_ `access_key` — The StatelyDB access key credential
           # 
           # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-          def initialize: (origin: String, access_key: String, base_retry_backoff_secs: Float) -> void
+          def initialize: (endpoint: String, access_key: String, base_retry_backoff_secs: Float) -> void
 
           # Initialize the actor. This runs on the actor thread which means
           # we can dispatch async operations here.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -72,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - lib/api/auth/get_auth_token_pb.rb
 - lib/api/auth/service_pb.rb