momento 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae73ad26d383968c4b0335be41cc9aa1b95078cdbff65b012d54f0309573df3
-  data.tar.gz: c7717a54a117809b0c0c2cc1fbb2576a1f8046c3577627922055ec89093f38de
+  metadata.gz: 8c0a2e256e81604bf29029b9b7e280ad7447a988b030e2b0e4597f1203ab1716
+  data.tar.gz: fcec32b5f2994ec2cd4c36a55b6e832d795347c9e4b7ce953b9ab364abbbc6d1
 SHA512:
-  metadata.gz: 4723e7ebb12ae06ffd1a0c7fe75c5c5eb516bec1e9474c8283b1f4412d319a9c2e402262b4141c6bd90840f74856915182f85ae082c7b1615d85eba397aec4cf
-  data.tar.gz: 5dffb98bf9c697786ef1bd5bb2c92bd406738c1c4564cdf5e09a76f760254abd4409eadd8fc0862870b1e1a8f71af6d483315f010a1e432539d1842396a86daf
+  metadata.gz: 4e41395f678e2b7cd093b26e0770d76883c4066479ab1beebb85ce6da66c78f0706965b6779d11a15838aa796f1bb73ba8d110b7527ba7ef6012ff6692f9568a
+  data.tar.gz: 907ecfb588f18ea17b34ac4d4e9539b451614f2ac0b14bed7500d2671f5cdf016981413d69473ac3cc09d173d2c46c1a924adcbcf21c92adb507629328880df0

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.0"
+  ".": "0.5.0"
 }

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   TargetRubyVersion: 2.7
   Exclude:
     # Generated protobuf files
-    - 'lib/**/*_pb.rb'
+    - 'lib/momento/generated/**/*'
     - 'vendor/**/*'
 
 Layout/ArgumentAlignment:
@@ -71,3 +71,16 @@ Style/WordArray:
 
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - 'lib/momento/generated/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/momento/generated/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/momento/generated/**/*'
+
+RSpec/FactoryBot/FactoryClassName:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1.2
+3.2.2

data/CHANGELOG.md

@@ -1,5 +1,110 @@
 # Changelog
 
+## [0.5.0](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.9...momento/v0.5.0) (2024-06-18)
+
+
+### Features
+
+* add InRegion pre-built config ([#180](https://github.com/momentohq/client-sdk-ruby/issues/180)) ([6dd2ef4](https://github.com/momentohq/client-sdk-ruby/commit/6dd2ef47443dbbd0cae28e1d4451c74352310aa3))
+* add runtime version header, only send agent headers on first request ([#177](https://github.com/momentohq/client-sdk-ruby/issues/177)) ([2292a35](https://github.com/momentohq/client-sdk-ruby/commit/2292a3575c551a2a36c9c3f1a31f0c6870e1c4d1))
+* add support for multiple grpc channels, fix configuration modifiers ([#176](https://github.com/momentohq/client-sdk-ruby/issues/176)) ([5753247](https://github.com/momentohq/client-sdk-ruby/commit/57532472d418db54c6eadd046ea6cbf0a53e4e96))
+
+
+### Bug Fixes
+
+* add Gemfile.lock to .gitignore ([45e0b6c](https://github.com/momentohq/client-sdk-ruby/commit/45e0b6cdfb19a337f6cb6c17afe2f21fd86b1eb5))
+* improve error handling for env var cred provider, other fixes ([#173](https://github.com/momentohq/client-sdk-ruby/issues/173)) ([c0b691b](https://github.com/momentohq/client-sdk-ruby/commit/c0b691b8c925d99b6a95a9cecee160b777b9dfab))
+
+## [0.4.9](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.8...momento/v0.4.9) (2024-04-30)
+
+### Bug Fixes
+
+* remove token and specify email for the redundant tag ([#168](https://github.com/momentohq/client-sdk-ruby/issues/168)) ([c119376](https://github.com/momentohq/client-sdk-ruby/commit/c11937641acce6b55dbb7e59f87f548769ad9313))
+
+## [0.4.8](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.7...momento/v0.4.8) (2024-04-30)
+
+
+### Bug Fixes
+
+* check out the repo with the machine user token ([#166](https://github.com/momentohq/client-sdk-ruby/issues/166)) ([67845af](https://github.com/momentohq/client-sdk-ruby/commit/67845af1da172271ea0e604d4ab8d6e749a7d7c1))
+
+## [0.4.7](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.6...momento/v0.4.7) (2024-04-30)
+
+
+### Bug Fixes
+
+* update the grpc dependency ([#164](https://github.com/momentohq/client-sdk-ruby/issues/164)) ([00c0ee5](https://github.com/momentohq/client-sdk-ruby/commit/00c0ee578c63b2003b6de23506715447d762997a))
+
+## [0.4.6](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.5...momento/v0.4.6) (2024-04-30)
+
+
+### Bug Fixes
+
+* check for local changes on release please failure ([#162](https://github.com/momentohq/client-sdk-ruby/issues/162)) ([bf8322c](https://github.com/momentohq/client-sdk-ruby/commit/bf8322c2cbd887c595db537838e227a0e66ebeb3))
+
+## [0.4.5](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.4...momento/v0.4.5) (2024-04-30)
+
+
+### Bug Fixes
+
+* check for local changes after publishing the gem ([#160](https://github.com/momentohq/client-sdk-ruby/issues/160)) ([cd9f242](https://github.com/momentohq/client-sdk-ruby/commit/cd9f242d224b6541d11fe06df23311d7ee6f19d0))
+
+## [0.4.4](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.3...momento/v0.4.4) (2024-04-30)
+
+
+### Bug Fixes
+
+* separate 'bundle install' to see if it modifies the checkout ([#158](https://github.com/momentohq/client-sdk-ruby/issues/158)) ([dbb5d20](https://github.com/momentohq/client-sdk-ruby/commit/dbb5d20619fb556eeebec7f80ff55e02bd14c282))
+
+## [0.4.3](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.2...momento/v0.4.3) (2024-04-30)
+
+
+### Bug Fixes
+
+* verbose rubygems publishing ([#156](https://github.com/momentohq/client-sdk-ruby/issues/156)) ([0f6ec1f](https://github.com/momentohq/client-sdk-ruby/commit/0f6ec1fc958bb9473b4f508f2cb2d1e35beaf90c))
+
+## [0.4.2](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.1...momento/v0.4.2) (2024-04-30)
+
+
+### Bug Fixes
+
+* add git status for release-please troubleshooting ([#154](https://github.com/momentohq/client-sdk-ruby/issues/154)) ([115b4ef](https://github.com/momentohq/client-sdk-ruby/commit/115b4ef77c62344e1debd813d19adf47fa687f1b))
+
+## [0.4.1](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.4.0...momento/v0.4.1) (2024-04-29)
+
+
+### Bug Fixes
+
+* Update release please action versions ([#152](https://github.com/momentohq/client-sdk-ruby/issues/152)) ([c4241da](https://github.com/momentohq/client-sdk-ruby/commit/c4241daa72dcb1f73eafef9ef86618e51826c3fb))
+
+## [0.4.0](https://github.com/momentohq/client-sdk-ruby/compare/momento/v0.3.0...momento/v0.4.0) (2024-04-29)
+
+
+### Features
+
+* add a CredentialProvider ([#134](https://github.com/momentohq/client-sdk-ruby/issues/134)) ([c74f34a](https://github.com/momentohq/client-sdk-ruby/commit/c74f34a102d24b6f143376ac4c643139b2559394))
+* add a value alias in sorted_set_fetch ([#149](https://github.com/momentohq/client-sdk-ruby/issues/149)) ([f310df0](https://github.com/momentohq/client-sdk-ruby/commit/f310df08735a41bd834e27ef138897c2ac5aa5ce))
+* add cache config objects as CacheClient argument ([f8c1c86](https://github.com/momentohq/client-sdk-ruby/commit/f8c1c860fa05c83a766b0063835013b32cc35382))
+* add cache config objects as CacheClient argument ([#142](https://github.com/momentohq/client-sdk-ruby/issues/142)) ([1158039](https://github.com/momentohq/client-sdk-ruby/commit/1158039ab4caa8fb6ab491c71c82d9eae3ad4083))
+* add sorted set put and fetch by score ([#147](https://github.com/momentohq/client-sdk-ruby/issues/147)) ([a8fd259](https://github.com/momentohq/client-sdk-ruby/commit/a8fd259d09f273a3ed0c857b05610534d801673e))
+* rename SimpleCacheClient to CacheClient ([37e2183](https://github.com/momentohq/client-sdk-ruby/commit/37e2183390e3184ad6ce4429df15fdd4b8b15a74))
+* rename SimpleCacheClient to CacheClient ([#141](https://github.com/momentohq/client-sdk-ruby/issues/141)) ([f1e6d86](https://github.com/momentohq/client-sdk-ruby/commit/f1e6d86ea9665bb66164265a7baa85f729d798a8))
+* support UTF-8 cache names instead of just ASCII ([#148](https://github.com/momentohq/client-sdk-ruby/issues/148)) ([5627f52](https://github.com/momentohq/client-sdk-ruby/commit/5627f526ccb269383289f8b3a033890f868f936d))
+
+
+### Bug Fixes
+
+* change the ruby versions in the test action to strings ([4700338](https://github.com/momentohq/client-sdk-ruby/commit/47003387cbab0739361eedcdad9662f0a0753757))
+* change the ruby versions in the test action to strings ([#136](https://github.com/momentohq/client-sdk-ruby/issues/136)) ([975be89](https://github.com/momentohq/client-sdk-ruby/commit/975be891c7cea139b6365698cf80d74db718bc3f))
+* fill out credential provider method docs ([#151](https://github.com/momentohq/client-sdk-ruby/issues/151)) ([90a8a39](https://github.com/momentohq/client-sdk-ruby/commit/90a8a39a50c908cc927fbdb8307fb50d29d7b960))
+
+## [0.3.0](https://github.com/momentohq/client-sdk-ruby/compare/momento-v0.2.0...momento/v0.3.0) (2023-11-09)
+
+
+### Features
+
+* add support for v1 tokens ([0a98c34](https://github.com/momentohq/client-sdk-ruby/commit/0a98c3404972966a7c4c2017908f2c204532712d))
+
 ## [0.2.0](https://github.com/momentohq/client-sdk-ruby/compare/momento-v0.1.0...momento/v0.2.0) (2022-12-07)
 
 ### Breaking Changes

data/CONTRIBUTING.md

@@ -40,13 +40,12 @@ You can run code from the repository's `lib/` directory by adding `-Ilib` to you
 
 You can also build a gem from local sources and install it. Run `bundle exec rake install`.
 
-## Running unit tests
+## Running tests
 
-Run `rspec`. These tests will make no network calls and do not require a Momento account.
-
-## Running integration tests
-
-TODO
+You will need a momento API key that you can generate on the [Momento Console](https://console.gomomento.com/api-keys).
+1. Set the environment variable `MOMENTO_API_KEY` to your Momento API key.
+2. Optionally set the environment variable `TEST_CACHE_NAME` to a cache that is safe to test with and delete. If you don't do this, the cache 'ruby-test-cache' will be used by default.
+3. Run `rspec` from the command line to execute the tests.
 
 ## Bug reports
 

data/Gemfile

@@ -2,10 +2,5 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in momento-client.gemspec
+# Specify your gem's dependencies in momento.gemspec
 gemspec
-
-gem "pry-byebug"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.38"

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    momento (0.2.0)
-      grpc (~> 1)
-      jwt (~> 2)
+    momento (0.5.0)
+      grpc (~> 1.62)
 
 GEM
   remote: https://rubygems.org/
@@ -23,15 +22,19 @@ GEM
       activesupport (>= 5.0.0)
     faker (3.0.0)
       i18n (>= 1.8.11, < 2)
-    google-protobuf (3.21.10-x86_64-darwin)
-    google-protobuf (3.21.10-x86_64-linux)
-    googleapis-common-protos-types (1.4.0)
-      google-protobuf (~> 3.14)
-    grpc (1.50.0-x86_64-darwin)
-      google-protobuf (~> 3.21)
+    google-protobuf (3.25.3-arm64-darwin)
+    google-protobuf (3.25.3-x86_64-darwin)
+    google-protobuf (3.25.3-x86_64-linux)
+    googleapis-common-protos-types (1.14.0)
+      google-protobuf (~> 3.18)
+    grpc (1.62.0-arm64-darwin)
+      google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
-    grpc (1.50.0-x86_64-linux)
-      google-protobuf (~> 3.21)
+    grpc (1.62.0-x86_64-darwin)
+      google-protobuf (~> 3.25)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.62.0-x86_64-linux)
+      google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -51,20 +54,21 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -91,14 +95,15 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    yard (0.9.36)
 
 PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux
@@ -107,10 +112,11 @@ DEPENDENCIES
   bundler (~> 2.3)
   factory_bot (~> 6.2.1)
   faker (~> 3.0)
+  jwt (~> 2)
   momento!
-  pry-byebug
+  pry-byebug (~> 3)
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.12)
   rubocop (~> 1.38)
   rubocop-performance (~> 1.15)
   rubocop-rake (~> 0.6.0)

data/README.md

@@ -1,40 +1,36 @@
 <head>
-  <meta name="Momento Ruby Client Library Documentation" content="Ruby client software development kit for Momento Serverless Cache">
+  <meta name="Momento Ruby Client Library Documentation" content="Ruby client software development kit for Momento Cache">
 </head>
-<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>
+<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-alpha.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 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.
 
-:warning: Alpha SDK :warning:
+To get started with Momento you will need a Momento Auth Token. You can get one from the [Momento Console](https://console.gomomento.com).
 
-This is an official Momento SDK, but the API is in an alpha stage and may be subject to backward-incompatible
-changes.  For more info, click on the alpha badge above.
+* 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)
+* Discuss: [Momento Discord](https://discord.gg/3HkAKjUZGq)
 
+# Momento Ruby SDK
 
-Ruby client SDK for Momento Serverless Cache: a fast, simple, pay-as-you-go caching solution without
-any of the operational overhead required by traditional caching solutions!
+To get started with Momento you will need a Momento API key. You can get one from the [Momento Console](https://console.gomomento.com/api-keys).
 
+* 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)
+* Discuss: [Momento Discord](https://discord.gg/3HkAKjUZGq)
 
+## Packages
 
-## Getting Started :running:
-
-### Requirements
-
-- A Momento Auth Token is required, you can generate one using
-  the [Momento CLI](https://github.com/momentohq/momento-cli).
-- Ruby 2.7 or newer.
-
-An IDE with good Ruby support, such as [RubyMine](https://www.jetbrains.com/ruby/), is recommended.
-
-### Examples
-
-You can find this example code and more in [the examples directory](https://github.com/momentohq/client-sdk-ruby/tree/main/examples) of this repository.
-
-### Installation
+The Momento Ruby SDK is available on [RubyGems](https://rubygems.org/gems/momento) 
 
 Install the gem and add to an application's Gemfile by executing:
 
@@ -48,32 +44,47 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install momento
 ```
 
-#### Note: M1 or M2 Macs
+You will need Ruby 2.7 or newer.
+
+An IDE with good Ruby support, such as [RubyMine](https://www.jetbrains.com/ruby/), is recommended.
 
-If you're using an M1 or M2 Mac, you may have trouble installing the `grpc` gem; [see this issue for more information](https://github.com/grpc/grpc/issues/31215).
+**Note: M1 or M2 Macs**: If you're using an M1 or M2 Mac, you may have trouble installing the `grpc` gem; [see this issue for more information](https://github.com/grpc/grpc/issues/31215).
 
 [A work around](https://github.com/grpc/grpc/pull/31151#issuecomment-1310321807) is to run `bundle config build.grpc --with-ldflags="-Wl,-undefined,dynamic_lookup"` before doing `bundle install`.
 
-### Usage
+## Usage
+
+You can find this example code and more in [the examples directory](./examples) of this repository.
 
 ```ruby
 # An example of the basic functionality of
-# Momento::SimpleCacheClient.
+# Momento::CacheClient.
 
 require 'momento'
 
-# Get your Momento token from an environment variable.
-TOKEN = ENV.fetch('MOMENTO_AUTH_TOKEN')
-
 # Cached items will be deleted after 12.5 seconds.
 TTL_SECONDS = 12.5
 
 # The name of the cache to create *and delete*
-CACHE_NAME = ENV.fetch('MOMENTO_CACHE_NAME')
+CACHE_NAME = ENV.fetch('MOMENTO_CACHE_NAME', 'ruby-examples')
+
+# Create a credential provider that loads a Momento API Key from an environment variable.
+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
+# 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,
+# you can use the with_num_connections method.
+# configuration = configuration.with_num_connections(4)
 
 # Instantiate a Momento client.
-client = Momento::SimpleCacheClient.new(
-  auth_token: TOKEN,
+client = Momento::CacheClient.new(
+  configuration: configuration,
+  credential_provider: credential_provider,
   default_ttl: TTL_SECONDS
 )
 
@@ -88,7 +99,12 @@ elsif response.error?
 end
 
 # List our caches.
-puts "Caches: #{client.caches.to_a.join(", ")}"
+response = client.list_caches
+if response.success?
+  puts "Caches: #{response.cache_names&.join(", ")}"
+elsif response.error?
+  raise "Couldn't list the caches: #{response.error}"
+end
 
 # Put an item in the cache.
 response = client.set(CACHE_NAME, "key", "You cached something!")
@@ -126,12 +142,20 @@ end
 
 ```
 
-### Error Handling
+## Getting Started and Documentation
+
+General documentation on Momento and the Momento SDKs is available on the [Momento Docs website](https://docs.momentohq.com/). Specific usage examples for the Ruby SDK are coming soon!
 
-[Momento::SimpleCacheClient](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/simple_cache_client.rb) follows the philosophy that when working with a service,
+## Examples
+
+Check out full working code in the [example](./example/) directory of this repository!
+
+## Error Handling
+
+[Momento::CacheClient](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/cache_client.rb) follows the philosophy that when working with a service,
 [exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs). Minor outages are a fact of life; they are normal rather than exceptional.
 
-When there is a problem, Momento::SimpleCacheClient methods return an error response, the same as any other response. This makes errors more visible, allows your IDE to be more helpful in ensuring that you've handled the responses you care about.
+When there is a problem, Momento::CacheClient methods return an error response, the same as any other response. This makes errors more visible, allows your IDE to be more helpful in ensuring that you've handled the responses you care about.
 
 Check if a response is an error with `response.error?`, get the error with `response.error`, and it can be raised as an exception with `raise response.error`. Generally, printing `response.error` tell you what you need to know, but you might want more details. Here's a contrived example.
 
@@ -155,21 +179,17 @@ elsif response.error?
 end
 ```
 
-Momento::SimpleCacheClient *will* raise exceptions for programmer mistakes such as passing the wrong type, typically an ArgumentError or TypeError. The exceptions are documented for each method.
+Momento::CacheClient *will* raise exceptions for programmer mistakes such as passing the wrong type, typically an ArgumentError or TypeError. The exceptions are documented for each method.
 
 See [Momento::Response](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/response.rb) for more about working with with error responses, and [Momento::Error](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/error.rb) for more about using errors.
 
-### Tuning
-
-Coming soon.
-
 ## Issues
 
 Please report any bugs, issues, requests, and feedback via this repo's [issue tracker](https://github.com/momentohq/client-sdk-ruby/issues).
 
-## Contributing
+## Developing
 
-See our [instructions for CONTRIBUTING](https://github.com/momentohq/client-sdk-ruby/blob/main/CONTRIBUTING.md).
+If you are interested in contributing to the SDK, please see the [CONTRIBUTING](./CONTRIBUTING.md) docs.
 
 ----------------------------------------------------------------------------------------
 For more info, visit our website at [https://gomomento.com](https://gomomento.com)!

data/README.template.md

@@ -1,20 +1,17 @@
 {{ ossHeader }}
 
-## Getting Started :running:
+# Momento Ruby SDK
 
-### Requirements
+To get started with Momento you will need a Momento API key. You can get one from the [Momento Console](https://console.gomomento.com/api-keys).
 
-- A Momento Auth Token is required, you can generate one using
-  the [Momento CLI](https://github.com/momentohq/momento-cli).
-- Ruby 2.7 or newer.
+* 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)
+* Discuss: [Momento Discord](https://discord.gg/3HkAKjUZGq)
 
-An IDE with good Ruby support, such as [RubyMine](https://www.jetbrains.com/ruby/), is recommended.
-
-### Examples
-
-You can find this example code and more in [the examples directory](https://github.com/momentohq/client-sdk-ruby/tree/main/examples) of this repository.
+## Packages
 
-### Installation
+The Momento Ruby SDK is available on [RubyGems](https://rubygems.org/gems/momento) 
 
 Install the gem and add to an application's Gemfile by executing:
 
@@ -28,24 +25,36 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install momento
 ```
 
-#### Note: M1 or M2 Macs
+You will need Ruby 2.7 or newer.
 
-If you're using an M1 or M2 Mac, you may have trouble installing the `grpc` gem; [see this issue for more information](https://github.com/grpc/grpc/issues/31215).
+An IDE with good Ruby support, such as [RubyMine](https://www.jetbrains.com/ruby/), is recommended.
+
+**Note: M1 or M2 Macs**: If you're using an M1 or M2 Mac, you may have trouble installing the `grpc` gem; [see this issue for more information](https://github.com/grpc/grpc/issues/31215).
 
 [A work around](https://github.com/grpc/grpc/pull/31151#issuecomment-1310321807) is to run `bundle config build.grpc --with-ldflags="-Wl,-undefined,dynamic_lookup"` before doing `bundle install`.
 
-### Usage
+## Usage
+
+You can find this example code and more in [the examples directory](./examples) of this repository.
 
 ```ruby
-{{ usageExampleCode }}
+{% include "./examples/example.rb" %}
 ```
 
-### Error Handling
+## Getting Started and Documentation
 
-[Momento::SimpleCacheClient](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/simple_cache_client.rb) follows the philosophy that when working with a service,
+General documentation on Momento and the Momento SDKs is available on the [Momento Docs website](https://docs.momentohq.com/). Specific usage examples for the Ruby SDK are coming soon!
+
+## Examples
+
+Check out full working code in the [example](./example/) directory of this repository!
+
+## Error Handling
+
+[Momento::CacheClient](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/cache_client.rb) follows the philosophy that when working with a service,
 [exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs). Minor outages are a fact of life; they are normal rather than exceptional.
 
-When there is a problem, Momento::SimpleCacheClient methods return an error response, the same as any other response. This makes errors more visible, allows your IDE to be more helpful in ensuring that you've handled the responses you care about.
+When there is a problem, Momento::CacheClient methods return an error response, the same as any other response. This makes errors more visible, allows your IDE to be more helpful in ensuring that you've handled the responses you care about.
 
 Check if a response is an error with `response.error?`, get the error with `response.error`, and it can be raised as an exception with `raise response.error`. Generally, printing `response.error` tell you what you need to know, but you might want more details. Here's a contrived example.
 
@@ -69,20 +78,16 @@ elsif response.error?
 end
 ```
 
-Momento::SimpleCacheClient *will* raise exceptions for programmer mistakes such as passing the wrong type, typically an ArgumentError or TypeError. The exceptions are documented for each method.
+Momento::CacheClient *will* raise exceptions for programmer mistakes such as passing the wrong type, typically an ArgumentError or TypeError. The exceptions are documented for each method.
 
 See [Momento::Response](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/response.rb) for more about working with with error responses, and [Momento::Error](https://github.com/momentohq/client-sdk-ruby/blob/main/lib/momento/error.rb) for more about using errors.
 
-### Tuning
-
-Coming soon.
-
 ## Issues
 
 Please report any bugs, issues, requests, and feedback via this repo's [issue tracker](https://github.com/momentohq/client-sdk-ruby/issues).
 
-## Contributing
+## Developing
 
-See our [instructions for CONTRIBUTING](https://github.com/momentohq/client-sdk-ruby/blob/main/CONTRIBUTING.md).
+If you are interested in contributing to the SDK, please see the [CONTRIBUTING](./CONTRIBUTING.md) docs.
 
 {{ ossFooter }}

data/examples/.gitignore

@@ -1 +1,2 @@
 test_copy.jpg
+Gemfile.lock

data/examples/Gemfile

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

data/examples/README.md

@@ -17,17 +17,16 @@ bundle
 Then, set the required environment variables:
 
 ```bash
-export MOMENTO_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
-export CACHE_NAME=<YOUR_CACHE_NAME>
+export MOMENTO_API_KEY=<YOUR_API_KEY>
 ```
 
 And now you can run the example programs.
 
-* example.rb - shows off all the basic functionality
-* compact.rb - the same, written in a compact style
-* file.rb - demonstrates how to cache a file
+* `ruby ./example.rb` - shows off all the basic functionality
+* `ruby ./compact.rb` - the same, written in a compact style
+* `ruby ./file.rb` - demonstrates how to cache a file
 
-If you wish to use the version of momento in this repository, include the lib directory when you run the examples.
+If you wish to use the version of Momento in this repository, include the lib directory when you run the examples.
 
 ```sh
 ruby -I../lib example.rb