momento 0.5.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6c7b43f3c86bd649bb9142ce480a47cc9bb5170b19574faad12702882d9a71
-  data.tar.gz: 316ca34d216b1aad4e3cb3c09f71ed09ce1bdaf27244c5087f2606a8dd266843
+  metadata.gz: d710dce969543a0ceca5d48787b0caa8900068d41897d1f58bb5e376f0ef6fc5
+  data.tar.gz: 20667320d3f97f74e1e4b4620f9f0e9922a76cbecde617c5da06129187444bc8
 SHA512:
-  metadata.gz: 957cd146d883a440d6d7b6b11a40b385a8f828641dc4d44f19be3886962ebbcd1a72e8502455f3e538708b840f2d49cef4e6b985129bd9d15bd6ce82fb2bdcb7
-  data.tar.gz: c63138d8888a4a4f75c94e5f791a8eb47cc445a046c62c26649dd025e8c1f17b998492db1151075cf0b8695200cb806fa50b2f729259ef88462c88cfc29b46b9
+  metadata.gz: 8a947860bed1a3e0f7ebab1e3740bcbb73d55d69f476988a42226fc20cd6203d0c8eb6987ce089c4d6949d5d3340ed4c311b314fb78bf1d22c41d0251b5872a2
+  data.tar.gz: 59fbc4168cc931a1e6d4672610b1402b044e59ee78c9b51439eec66634f86c39aab50f437490f4b21ebc074f9e29e7cacd3e7e82335618f80c8ff50475a7b672

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.5.1"
+  ".": "0.6.4"
 }

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## [0.6.4](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.6.3...momento/v0.6.4) (2026-01-08)
+
+
+### Bug Fixes
+
+* run bundle install and use bundle exec to call rake build ([28615a7](https://github.com/momentohq/client-sdk-ruby/commit/28615a7834cabef92215661eb8833d468c7fd4d9))
+* run bundle install and use bundle exec to call rake build ([#206](https://github.com/momentohq/client-sdk-ruby/issues/206)) ([16256d2](https://github.com/momentohq/client-sdk-ruby/commit/16256d273ea48c61395bd1bf12fba4d8a31066af))
+
+## [0.6.3](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.6.2...momento/v0.6.3) (2026-01-08)
+
+
+### Bug Fixes
+
+* use rake build to package gem for publishing ([c6c8ac3](https://github.com/momentohq/client-sdk-ruby/commit/c6c8ac3e9dd293b3aa3fd3bdeaeb870870f0cf35))
+* use rake build to package gem for publishing ([#204](https://github.com/momentohq/client-sdk-ruby/issues/204)) ([a6a7105](https://github.com/momentohq/client-sdk-ruby/commit/a6a71051f99fc1805c6dcd2ed9c79770b2d5a6fc))
+
+## [0.6.2](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.6.1...momento/v0.6.2) (2026-01-08)
+
+
+### Miscellaneous Chores
+
+* release 0.6.2 ([e435dde](https://github.com/momentohq/client-sdk-ruby/commit/e435dde85def1dea661169a92f3ecc5dec477523))
+* release 0.6.2 ([#202](https://github.com/momentohq/client-sdk-ruby/issues/202)) ([210dbf1](https://github.com/momentohq/client-sdk-ruby/commit/210dbf10ad3056e9f142620c6d4726a3e1a8e856))
+
+## [0.6.1](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.6.0...momento/v0.6.1) (2025-12-17)
+
+
+### Miscellaneous Chores
+
+* release 0.6.1 ([d857669](https://github.com/momentohq/client-sdk-ruby/commit/d857669abf0934391e61580832f713142c187a17))
+* release 0.6.1 ([#198](https://github.com/momentohq/client-sdk-ruby/issues/198)) ([ed8998e](https://github.com/momentohq/client-sdk-ruby/commit/ed8998e361068ce2100fc5b54c65c13c483a4990))
+
+## [0.6.0](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.5.2...momento/v0.6.0) (2025-12-15)
+
+
+### Features
+
+* new credential provider methods for accepting global api keys ([eb4737f](https://github.com/momentohq/client-sdk-ruby/commit/eb4737ff608e15dad77064e40157da3b4691b2da))
+* new credential provider methods for accepting v2 api keys ([#195](https://github.com/momentohq/client-sdk-ruby/issues/195)) ([79e3777](https://github.com/momentohq/client-sdk-ruby/commit/79e37776ef9c7a8703bddc3dfbe569af8e42e888))
+
+
+### Bug Fixes
+
+* disable dynamic DNS service config ([#194](https://github.com/momentohq/client-sdk-ruby/issues/194)) ([d9a0976](https://github.com/momentohq/client-sdk-ruby/commit/d9a0976dec3c8ab68e8ed4a83d50ee97963fb4b1))
+* only configure git in release please if the repo was checked out ([#192](https://github.com/momentohq/client-sdk-ruby/issues/192)) ([d202329](https://github.com/momentohq/client-sdk-ruby/commit/d2023298b388e36616e766157d2a7ad017f07917))
+
+## [0.5.2](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.5.1...momento/v0.5.2) (2024-11-25)
+
+
+### Bug Fixes
+
+* copyright info ([87d44d5](https://github.com/momentohq/client-sdk-ruby/commit/87d44d525041c4cd2e060fd63765ebb35904badb))
+* copyright info ([#190](https://github.com/momentohq/client-sdk-ruby/issues/190)) ([47f3904](https://github.com/momentohq/client-sdk-ruby/commit/47f3904d39451957313f3306323e2c636945d971))
+
 ## [0.5.1](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.5.0...momento/v0.5.1) (2024-06-18)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    momento (0.5.1)
+    momento (0.6.4)
       grpc (~> 1.62)
 
 GEM

data/LICENSE.txt

@@ -186,7 +186,7 @@ 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 [yyyy] [name of copyright owner]
+Copyright 2024 Momento Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,22 +1,22 @@
 <head>
-  <meta name="Momento Ruby Client Library Documentation" content="Ruby client software development kit for Momento Cache">
+  <meta name="Momento Client Library Documentation for Ruby" content="Momento client software development kit for Ruby">
 </head>
 <img src="https://docs.momentohq.com/img/momento-logo-forest.svg" alt="logo" width="400"/>
 
 [![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)
 [![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-stable.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)
 
-# Momento Ruby Client Library
+# Momento Client Library for Ruby
 
 Momento Cache is a fast, simple, pay-as-you-go caching solution without any of the operational overhead
-required by traditional caching solutions.  This repo contains the source code for the Momento Ruby client library.
+required by traditional caching solutions.  This repo contains the source code for the Momento client library for Ruby.
 
 To get started with Momento you will need a Momento Auth Token. You can get one from the [Momento Console](https://console.gomomento.com).
 
 * Website: [https://www.gomomento.com/](https://www.gomomento.com/)
 * Momento Documentation: [https://docs.momentohq.com/](https://docs.momentohq.com/)
 * Getting Started: [https://docs.momentohq.com/getting-started](https://docs.momentohq.com/getting-started)
-* Ruby SDK Documentation: [https://docs.momentohq.com/sdks/ruby](https://docs.momentohq.com/sdks/ruby)
+* Momento SDK Documentation for Ruby: [https://docs.momentohq.com/sdks/ruby](https://docs.momentohq.com/sdks/ruby)
 * Discuss: [Momento Discord](https://discord.gg/3HkAKjUZGq)
 
 # Momento Ruby SDK
@@ -74,7 +74,7 @@ credential_provider = Momento::CredentialProvider.from_env_var('MOMENTO_API_KEY'
 # This is a reasonable configuration for dev work on a laptop.
 configuration = Momento::Cache::Configurations::Laptop.latest
 # This configuration might be better for a production where you want more aggressive timeouts
-# configuration = Momento::Cache::Configuration::InRegion.latest
+# configuration = Momento::Cache::Configurations::InRegion.latest
 # To set a custom timeout, you can use the with_timeout method.
 # configuration = configuration.with_timeout(10_000)
 # To increase the number of TCP connections for a client where you expect a high volume of traffic,

data/examples/Gemfile

@@ -2,4 +2,4 @@
 
 source "https://rubygems.org"
 
-gem 'momento', '~> 0.4.9'
+gem 'momento', '~> 0.5.2'

data/examples/example.rb

@@ -15,7 +15,7 @@ credential_provider = Momento::CredentialProvider.from_env_var('MOMENTO_API_KEY'
 # This is a reasonable configuration for dev work on a laptop.
 configuration = Momento::Cache::Configurations::Laptop.latest
 # This configuration might be better for a production where you want more aggressive timeouts
-# configuration = Momento::Cache::Configuration::InRegion.latest
+# configuration = Momento::Cache::Configurations::InRegion.latest
 # To set a custom timeout, you can use the with_timeout method.
 # configuration = configuration.with_timeout(10_000)
 # To increase the number of TCP connections for a client where you expect a high volume of traffic,

data/lib/momento/auth/credential_provider.rb

@@ -10,6 +10,7 @@ module Momento
     # @param env_var_name [String] the environment variable containing the API key
     # @return [Momento::CredentialProvider]
     # @raise [Momento::Error::InvalidArgumentError] if the API key is invalid
+    # @deprecated Please use {#from_env_var_v2} instead.
     def self.from_env_var(env_var_name)
       api_key = ENV.fetch(env_var_name) {
         raise Momento::Error::InvalidArgumentError, "Env var #{env_var_name} must be set"
@@ -21,15 +22,84 @@ module Momento
     # @param api_key [String] the Momento API key
     # @return [Momento::CredentialProvider]
     # @raise [Momento::Error::InvalidArgumentError] if the API key is invalid
+    # @deprecated Please use {#from_api_key_v2} or {#from_disposable_token} instead.
     def self.from_string(api_key)
       raise Momento::Error::InvalidArgumentError, 'Auth token string cannot be empty' if api_key.empty?
 
       new(api_key)
     end
 
+    # Creates a CredentialProvider from a Momento disposable token
+    # @param token [String] the Momento disposable token
+    # @return [Momento::CredentialProvider]
+    # @raise [Momento::Error::InvalidArgumentError] if the token is invalid
+    def self.from_disposable_token(token)
+      raise Momento::Error::InvalidArgumentError, 'Auth token string cannot be empty' if token.empty?
+
+      new(token)
+    end
+
+    # Creates a CredentialProvider from a v2 API key string and endpoint.
+    # @param api_key [String] the v2 API key
+    # @param endpoint [String] the Momento service endpoint
+    # @return [Momento::CredentialProvider]
+    # @raise [Momento::Error::InvalidArgumentError] if parameters are invalid
+    def self.from_api_key_v2(api_key:, endpoint:)
+      raise Momento::Error::InvalidArgumentError, 'API key cannot be empty' if api_key.nil? || api_key.empty?
+      raise Momento::Error::InvalidArgumentError, 'Endpoint cannot be empty' if endpoint.nil? || endpoint.empty?
+
+      unless v2_api_key?(api_key)
+        raise Momento::Error::InvalidArgumentError,
+          'Received an invalid v2 API key. Are you using the correct key? \
+          Or did you mean to use `from_string()` with a legacy key instead?'
+      end
+
+      allocate.tap do |instance|
+        instance.send(:initialize_from_v2, api_key, endpoint)
+      end
+    end
+
+    # Creates a CredentialProvider from a v2 API key and endpoint loaded from environment variables
+    # MOMENTO_API_KEY and MOMENTO_ENDPOINT by default.
+    # @param api_key_env_var [String] optionally provide alternate environment variable containing the v2 API key
+    # @param endpoint_env_var [String] optionally provide alternate environment variable containing the endpoint
+    # @return [Momento::CredentialProvider]
+    # @raise [Momento::Error::InvalidArgumentError] if parameters are invalid
+    def self.from_env_var_v2(api_key_env_var: "MOMENTO_API_KEY", endpoint_env_var: "MOMENTO_ENDPOINT")
+      api_key = ENV.fetch(api_key_env_var) {
+        raise Momento::Error::InvalidArgumentError, "Env var #{api_key_env_var} must be set"
+      }
+      endpoint = ENV.fetch(endpoint_env_var) {
+        raise Momento::Error::InvalidArgumentError, "Env var #{endpoint_env_var} must be set"
+      }
+      unless v2_api_key?(api_key)
+        raise Momento::Error::InvalidArgumentError,
+          'Received an invalid v2 API key. Are you using the correct key? \
+          Or did you mean to use `from_env_var()` with a legacy key instead?'
+      end
+      allocate.tap do |instance|
+        instance.send(:initialize_from_v2, api_key, endpoint)
+      end
+    end
+
     private
 
+    def initialize_from_v2(api_key, endpoint)
+      raise Momento::Error::InvalidArgumentError, 'API key cannot be empty' if api_key.nil? || api_key.empty?
+      raise Momento::Error::InvalidArgumentError, 'Endpoint cannot be empty' if endpoint.nil? || endpoint.empty?
+
+      @api_key = api_key
+      @control_endpoint = "control.#{endpoint}"
+      @cache_endpoint = "cache.#{endpoint}"
+    end
+
     def initialize(api_key)
+      if v2_api_key?(api_key)
+        raise Momento::Error::InvalidArgumentError,
+          'Received a v2 API key. Are you using the correct key? Or did you mean to use\
+           `from_api_key_v2()` or `from_env_var_v2()` instead?'
+      end
+
       decoded_token = decode_api_key(api_key)
       @api_key = decoded_token.api_key
       @control_endpoint = decoded_token.control_endpoint
@@ -76,3 +146,25 @@ module Momento
     end
   end
 end
+
+def base64?(string)
+  return false if string.nil? || string.empty?
+
+  Base64.strict_decode64(string)
+  true
+rescue ArgumentError
+  false
+end
+
+def v2_api_key?(api_key)
+  false if base64?(api_key)
+
+  key_parts = api_key.split('.')
+  raise Momento::Error::InvalidArgumentError, 'Malformed legacy API key' if key_parts.size != 3
+
+  decoded_key = Base64.decode64(key_parts[1])
+  key_json = JSON.parse(decoded_key, symbolize_names: true)
+  key_json[:t] == 'g'
+rescue ArgumentError, JSON::ParserError
+  false
+end

data/lib/momento/cache_client.rb

@@ -345,7 +345,9 @@ module Momento
       @cache_stubs ||= (1..@num_cache_stubs).map {
         CACHE_CLIENT_STUB_CLASS.new(@cache_endpoint, combined_credentials,
           timeout: @configuration.transport_strategy.grpc_configuration.deadline,
-          channel_args: { 'grpc.use_local_subchannel_pool' => 1 }
+          channel_args: { 'grpc.use_local_subchannel_pool' => 1,
+                          # Disable service config resolution to avoid DNS TXT record lookups
+                          'grpc.service_config_disable_resolution' => 1 }
         )
       }
       @next_cache_stub_index = (@next_cache_stub_index + 1) % @num_cache_stubs
@@ -353,7 +355,10 @@ module Momento
     end
 
     def control_stub
-      @control_stub ||= CONTROL_CLIENT_STUB_CLASS.new(@control_endpoint, combined_credentials)
+      @control_stub ||= CONTROL_CLIENT_STUB_CLASS.new(@control_endpoint, combined_credentials,
+        # Disable service config resolution to avoid DNS TXT record lookups
+        channel_args: { 'grpc.service_config_disable_resolution' => 1 }
+      )
     end
 
     def combined_credentials

data/lib/momento/error/types.rb

@@ -146,16 +146,69 @@ module Momento
 
     # Request rate exceeded the limits for this account.
     class LimitExceededError < RuntimeError
-      include Momento::Error
+      attr_reader :details, :transport_details
+
+      def initialize(details = '', transport_details = nil)
+        super()
+        @details = details.to_s
+        @transport_details = transport_details
+      end
+
+      # Extract the error cause from metadata
+      def error_cause
+        metadata = transport_details&.grpc&.metadata || {}
+        metadata[:err] || 'unknown_error'
+      end
 
       # (see Momento::Error#error_code)
       def error_code
         :LIMIT_EXCEEDED_ERROR
       end
 
-      # (see Momento::Error#message)
+      class ErrorMessages
+        TOPIC_SUBSCRIPTIONS_LIMIT_EXCEEDED = 'Topic subscriptions limit exceeded.'.freeze
+        OPERATIONS_RATE_LIMIT_EXCEEDED = 'Operations rate limit exceeded.'.freeze
+        THROUGHPUT_RATE_LIMIT_EXCEEDED = 'Throughput rate limit exceeded.'.freeze
+        REQUEST_SIZE_LIMIT_EXCEEDED = 'Request size limit exceeded.'.freeze
+        ITEM_SIZE_LIMIT_EXCEEDED = 'Item size limit exceeded.'.freeze
+        ELEMENT_SIZE_LIMIT_EXCEEDED = 'Element size limit exceeded.'.freeze
+        UNKNOWN_LIMIT_EXCEEDED = 'Limit exceeded for this account.'.freeze
+
+        # Map error causes to the corresponding message
+        ERROR_CAUSES = {
+          'topic_subscriptions_limit_exceeded' => TOPIC_SUBSCRIPTIONS_LIMIT_EXCEEDED,
+          'operations_rate_limit_exceeded' => OPERATIONS_RATE_LIMIT_EXCEEDED,
+          'throughput_rate_limit_exceeded' => THROUGHPUT_RATE_LIMIT_EXCEEDED,
+          'request_size_limit_exceeded' => REQUEST_SIZE_LIMIT_EXCEEDED,
+          'item_size_limit_exceeded' => ITEM_SIZE_LIMIT_EXCEEDED,
+          'element_size_limit_exceeded' => ELEMENT_SIZE_LIMIT_EXCEEDED
+        }.freeze
+
+        # Map substrings to the corresponding message
+        ERROR_SUBSTRINGS = {
+          'subscribers' => TOPIC_SUBSCRIPTIONS_LIMIT_EXCEEDED,
+          'operations' => OPERATIONS_RATE_LIMIT_EXCEEDED,
+          'throughput' => THROUGHPUT_RATE_LIMIT_EXCEEDED,
+          'request limit' => REQUEST_SIZE_LIMIT_EXCEEDED,
+          'item size' => ITEM_SIZE_LIMIT_EXCEEDED,
+          'element size' => ELEMENT_SIZE_LIMIT_EXCEEDED
+        }.freeze
+      end
+
+      # Generate the appropriate message based on the error cause or details
       def message
-        "Request rate exceeded the limits for this account.  To resolve this error, reduce your request rate, or contact Momento to request a limit increase."
+        # First, check for a direct match in the ERROR_CAUSES for the error cause
+        message = ErrorMessages::ERROR_CAUSES[error_cause]
+
+        # If no direct match for error cause, then check if any substring in details matches
+        if message.nil?
+          ErrorMessages::ERROR_SUBSTRINGS.each do |key, msg|
+            return msg if details.include?(key)
+          end
+        end
+
+        # Return the default message if no match is found
+        message || ErrorMessages::UNKNOWN_LIMIT_EXCEEDED
       end
     end
 

data/lib/momento/version.rb

@@ -2,5 +2,5 @@
 
 module Momento
   # This gem's version.
-  VERSION = "0.5.1"
+  VERSION = "0.6.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momento
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.4
 platform: ruby
 authors:
 - Momento
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2026-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -321,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Client for Momento Serverless Cache