momento 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28402c3809544906082ae277798d4ffd2f82a20bf45fa9869edca7e3adf9bd9a
+  data.tar.gz: 4c8bac6308cc7a5ef23f025d909b6572907c4c1fc1c6386775b87006edee1a4c
+SHA512:
+  metadata.gz: 9fad68ffd8d9dd81deee23655464af02014ddc3348bd07f0c95d9534d2acf7c9cac858f175a62489d121f3ebce9cd1c641f27dfdafac1665239697b5dcd326dd
+  data.tar.gz: a38ac7f169d9917e015b3da3647ec01950fb1b769a11166c16df6a1013e398c3b2e910e292c6721e204c9b3a04a5237be25bfea58e3ad5ebfed43866a990ee48

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,61 @@
+require:
+  - 'rubocop-performance'
+  - 'rubocop-rake'
+  - 'rubocop-rspec'
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    # Generated protobuf files
+    - 'lib/**/*_pb.rb'
+    - 'vendor/**/*'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  # For rspec
+  AllowedPatterns: ['change']
+
+# The rspec defaults are way too tight.
+RSpec/ExampleLength:
+  Max: 15
+RSpec/MultipleExpectations:
+  Max: 4
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/ImplicitSubject:
+  EnforcedStyle: single_statement_only
+
+# end.method looks really weird, and the other styles are too fussy
+Style/BlockDelimiters:
+  Enabled: false
+
+# Enable it if they ever do anything with it.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# In a language which returns it's last evaluated expression,
+# it's useful to know when you intend to return vs when you don't.
+Style/RedundantReturn:
+  Enabled: false
+
+# Too fussy, doesn't solve a problem
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# I find the %x arrays hard to remember.
+Style/SymbolArray:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.2

data/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>
+
+# Welcome to client-sdk-ruby contributing guide :wave:
+
+Thank you for taking your time to contribute to our Ruby SDK!
+
+This guide will provide you information to start your own development and testing.
+
+Happy coding :dancer:
+
+
+## Requirements
+
+Check out our SDK [requirements](https://github.com/momentohq/client-sdk-ruby#Requirements)!
+
+
+## Installing Ruby
+
+Ruby might already be installed on your computer, but we recommend instead using your own Ruby.
+
+To install and manage your own Ruby, we suggest using either [`rvm`](https://rvm.io/) or [`rbenv`](https://github.com/rbenv/rbenv/).
+
+If you're on Windows, use [RubyInstaller](https://rubyinstaller.org/).
+
+You can also use a Docker image. `docker pull ruby` or any specific version of Ruby we support.
+
+
+## Setting up the dev environment
+
+1. Clone the repository.
+2. Change to the repository directory.
+3. Upgrade bundler: `gem install bundler`
+4. Install the dependencies: `bundle`
+
+This will install both the runtime and development dependencies.
+
+## Trying it out
+
+You can run code from the repository's `lib/` directory by adding `-Ilib` to your ruby commands. For example, `ruby -Ilib examples/basic.rb` or `irb -Ilib`. This will use the repository's code even if you have the gem installed.
+
+You can also build a gem from local sources and install it. Run `bundle exec rake install`.
+
+## Running unit tests
+
+Run `rspec`. These tests will make no network calls and do not require a Momento account.
+
+## Running integration tests
+
+TODO
+
+## Bug reports
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/momentohq/client-sdk-ruby.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    momento (0.1.0)
+      grpc (~> 1)
+      jwt (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    faker (3.0.0)
+      i18n (>= 1.8.11, < 2)
+    google-protobuf (3.21.9-x86_64-darwin)
+    google-protobuf (3.21.9-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)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.50.0-x86_64-linux)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    jwt (2.5.0)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  factory_bot (~> 6.2.1)
+  faker (~> 3.0)
+  momento!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.38)
+  rubocop-performance (~> 1.15)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.15)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.3.24

data/LICENSE.txt

@@ -0,0 +1,201 @@
+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 [yyyy] [name of copyright owner]
+
+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

@@ -0,0 +1,80 @@
+# Momento
+
+Client for Momento serverless caching service.
+
+## Installation
+
+Install the gem and add to an application's Gemfile by executing:
+
+    $ bundle add momento
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install momento
+
+### M1 or M2 Macs
+
+If you're using an M1 or M2 Mac, [you may have trouble installing the `grpc` gem](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`.
+
+## Requirements
+
+* A Momento Auth Token is required, you can generate one using the Momento CLI
+* Ruby >= 2.7
+
+## Usage
+
+```
+require 'momento'
+
+# Get your Momento token from an environment variable.
+token = ENV.fetch('MOMENTO_AUTH_TOKEN')
+
+# Cached items will be deleted after 30 seconds.
+ttl = 30_000
+
+# Instantiate a Momento client.
+client = Momento::SimpleCacheClient.new(
+  auth_token: token,
+  default_ttl: ttl
+)
+
+# Create a cache named "test_cache" to play with.
+response = client.create_cache("test_cache")
+if response.success? || response.already_exists?
+  puts "Created the cache, or it already exists."
+elsif response.error?
+  raise "Couldn't create a cache: #{response}"
+else
+  raise
+end
+
+# Put an item in the cache.
+response = client.set("test_cache", "key", "You cached something!")
+if response.success?
+  puts "Set an item in the cache."
+elsif response.error?
+  raise "Couldn't set an item in the cache: #{response}"
+else
+  raise
+end
+
+# And get it back.
+response = client.get("test_cache", "key")
+if response.hit?
+  puts "Cache returned: #{response.value}"
+elsif response.miss?
+  puts "The item wasn't found in the cache."
+elsif response.error?
+  raise "Couldn't get an item from the cache: #{response}"
+else
+  raise
+end
+```
+
+You can run this code from [examples/basic.rb](examples/basic.rb).
+
+## Contributing
+
+See our [instructions for CONTRIBUTING](./CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/examples/basic.rb

@@ -0,0 +1,45 @@
+require 'momento'
+
+# Get your Momento token from an environment variable.
+token = ENV.fetch('MOMENTO_AUTH_TOKEN')
+
+# Cached items will be deleted after 30 seconds.
+ttl = 30_000
+
+# Instantiate a Momento client.
+client = Momento::SimpleCacheClient.new(
+  auth_token: token,
+  default_ttl: ttl
+)
+
+# Create a cache named "test_cache" to play with.
+response = client.create_cache("test_cache")
+if response.success? || response.already_exists?
+  puts "Created the cache, or it already exists."
+elsif response.error?
+  raise "Couldn't create a cache: #{response}"
+else
+  raise
+end
+
+# Put an item in the cache.
+response = client.set("test_cache", "key", "You cached something!")
+if response.success?
+  puts "Set an item in the cache."
+elsif response.error?
+  raise "Couldn't set an item in the cache: #{response}"
+else
+  raise
+end
+
+# And get it back.
+response = client.get("test_cache", "key")
+if response.hit?
+  puts "Cache returned: #{response.value}"
+elsif response.miss?
+  puts "The item wasn't found in the cache."
+elsif response.error?
+  raise "Couldn't get an item from the cache: #{response}"
+else
+  raise
+end

data/lib/README-generating-pb.txt

@@ -0,0 +1,28 @@
+# 1. Fix the generated code.
+
+Currently, the Ruby code generated by gRPC will not compile.
+See https://github.com/momentohq/client-sdk-ruby/issues/12
+
+If #12 is not fixed, here are the steps to fix the PB classes.
+
+1. Generate them as normal using grpc_tools_ruby_protoc.
+2. Remove the leading `PB__` from the constants in ControlClient and CacheClient.
+3. Remove the leading `_` from the ControlClient and CacheClient references in the Service classes.
+
+Or...
+
+```
+perl -i -p -e 's{PB__}{}g' lib/*_pb.rb
+perl -i -p -e 's{\b_}{}g' lib/*_services_pb.rb
+```
+
+# 2. Place the generated classes under the Momento module.
+
+The generated classes are at the top level. That is unacceptable for a gem.
+
+Put them in their own namespace.
+
+1. Wrap the modules in `module Momento`.
+2. In the *_services_pb.rb files, change the module names.
+  * rename ::ControlClient to ::Momento::ControlClient
+  * rename ::CacheClient to ::Momento::CacheClient