momento 0.1.0

data/lib/momento/get_response.rb

@@ -0,0 +1,80 @@
+require 'grpc'
+require 'momento/cacheclient_pb'
+
+module Momento
+  # Responses specific to get.
+  class GetResponse < Response
+    class << self
+      # Build a Momento::GetResponse from a block of code
+      # which returns a Momento::ControlClient::GetResponse.
+      #
+      # @return [Momento::GetResponse]
+      # @raise [StandardError] when the exception is not recognized.
+      # @raise [TypeError] when the response is not recognized.
+      def from_block
+        response = yield
+      rescue GRPC::BadStatus => e
+        Error.new(grpc_exception: e)
+      else
+        from_response(response)
+      end
+
+      private
+
+      def from_response(response)
+        raise TypeError unless response.is_a?(Momento::CacheClient::GetResponse)
+
+        case response.result
+        when :Hit
+          Hit.new(grpc_response: response)
+        when :Miss
+          Miss.new
+        else
+          raise "Unknown get result: #{response.result}"
+        end
+      end
+    end
+
+    def hit?
+      false
+    end
+
+    def miss?
+      false
+    end
+
+    # Successfully got an item from the cache.
+    class Hit < GetResponse
+      # rubocop:disable Lint/MissingSuper
+      def initialize(grpc_response:)
+        @grpc_response = grpc_response
+      end
+      # rubocop:enable Lint/MissingSuper
+
+      def hit?
+        true
+      end
+
+      # @return [String] the value from the cache
+      def value
+        @grpc_response.cache_body
+      end
+
+      def to_s
+        value
+      end
+    end
+
+    # The key had no value stored in the cache.
+    class Miss < GetResponse
+      def miss?
+        true
+      end
+    end
+
+    # There was a problem getting the value from the cache.
+    class Error < GetResponse
+      include Momento::Response::Error
+    end
+  end
+end

data/lib/momento/list_caches_response.rb

@@ -0,0 +1,53 @@
+require 'grpc'
+require 'momento/controlclient_pb'
+
+module Momento
+  # Responses specific to list_caches.
+  class ListCachesResponse < Response
+    # Build a Momento::ListCachesResponse from a block of code
+    # which returns a Momento::ControlClient::ListCachesResponse.
+    #
+    # @return [Momento::ListCachesResponse]
+    # @raise [StandardError] when the exception is not recognized.
+    # @raise [TypeError] when the response is not recognized.
+    def self.from_block
+      response = yield
+    rescue GRPC::BadStatus => e
+      Error.new(grpc_exception: e)
+    else
+      raise TypeError unless response.is_a?(Momento::ControlClient::ListCachesResponse)
+
+      return Success.new(grpc_response: response)
+    end
+
+    def success?
+      false
+    end
+
+    # A Momento resposne with a page of caches.
+    class Success < ListCachesResponse
+      # rubocop:disable Lint/MissingSuper
+      def initialize(grpc_response:)
+        @grpc_response = grpc_response
+      end
+      # rubocop:enable Lint/MissingSuper
+
+      def success?
+        true
+      end
+
+      def cache_names
+        @grpc_response.cache.map(&:cache_name)
+      end
+
+      def next_token
+        @grpc_response.next_token
+      end
+    end
+
+    # There was an error listing the caches.
+    class Error < ListCachesResponse
+      include ::Momento::Response::Error
+    end
+  end
+end

data/lib/momento/response/error.rb

@@ -0,0 +1,16 @@
+module Momento
+  class Response
+    # A module for responses which contain errors.
+    module Error
+      attr_accessor :grpc_exception
+
+      def initialize(grpc_exception:)
+        @grpc_exception = grpc_exception
+      end
+
+      def error?
+        true
+      end
+    end
+  end
+end

data/lib/momento/response.rb

@@ -0,0 +1,17 @@
+require 'grpc'
+require_relative 'response/error'
+require_relative 'create_cache_response'
+require_relative 'delete_response'
+require_relative 'delete_cache_response'
+require_relative 'get_response'
+require_relative 'list_caches_response'
+require_relative 'set_response'
+
+module Momento
+  # A superclass for all Momento responses.
+  class Response
+    def error?
+      false
+    end
+  end
+end

data/lib/momento/set_response.rb

@@ -0,0 +1,39 @@
+require 'grpc'
+require 'momento/cacheclient_pb'
+
+module Momento
+  # Responses specific to set.
+  class SetResponse < Response
+    # Build a Momento::SetResponse from a block of code
+    # which returns a Momento::ControlClient::SetResponse.
+    #
+    # @return [Momento::SetResponse]
+    # @raise [StandardError] when the exception is not recognized.
+    # @raise [TypeError] when the response is not recognized.
+    def self.from_block
+      response = yield
+    rescue GRPC::BadStatus => e
+      Error.new(grpc_exception: e)
+    else
+      raise TypeError unless response.is_a?(Momento::CacheClient::SetResponse)
+
+      Success.new
+    end
+
+    def success?
+      false
+    end
+
+    # The item was set.
+    class Success < SetResponse
+      def success?
+        true
+      end
+    end
+
+    # There was an error setting the item.
+    class Error < SetResponse
+      include Momento::Response::Error
+    end
+  end
+end

data/lib/momento/simple_cache_client.rb

@@ -0,0 +1,204 @@
+require 'jwt'
+require 'momento/cacheclient_services_pb'
+require 'momento/controlclient_services_pb'
+require 'momento/response'
+
+module Momento
+  # A simple client for Momento.
+  #
+  # @example
+  #   client = Momento::SimpleCacheClient.new(
+  #     auth_token: jwt,
+  #     default_ttl: 10_000
+  #   )
+  #
+  #   response = client.get("my_cache", "key")
+  #   if response.hit?
+  #     puts "We got #{response}"
+  #   elsif response.miss?
+  #     puts "It's not in the cache"
+  #   elsif response.error?
+  #     puts "The front fell off."
+  #   end
+  class SimpleCacheClient
+    VERSION = Momento::VERSION
+    CACHE_CLIENT_STUB_CLASS = CacheClient::Scs::Stub
+    CONTROL_CLIENT_STUB_CLASS = ControlClient::ScsControl::Stub
+
+    # The default time to live, in milliseconds.
+    attr_accessor :default_ttl
+
+    # @param auth_token [String] the JWT for your Momento account
+    # @param default_ttl [Integer]
+    def initialize(auth_token:, default_ttl:)
+      @auth_token = auth_token
+      @default_ttl = default_ttl
+      load_endpoints_from_token
+    end
+
+    # Get a value in a cache.
+    #
+    # Momento only stores bytes; the returned value will be encoded as ASCII-8BIT.
+    #
+    # @param cache_name [String]
+    # @param key [String] must only contain ASCII characters
+    # @return [Momento::GetResponse]
+    def get(cache_name, key)
+      return GetResponse.from_block do
+        cache_stub.get(
+          CacheClient::GetRequest.new(cache_key: to_bytes(key)),
+          metadata: { cache: cache_name }
+        )
+      end
+    end
+
+    # Set a value in a cache.
+    #
+    # If ttl is not set, it will use the default_ttl.
+    #
+    # @param cache_name [String]
+    # @param key [String] must only contain ASCII characters
+    # @param value [String] the value to cache
+    # @param ttl [Integer] time to live, in milliseconds.
+    # @return [Momento::SetResponse]
+    def set(cache_name, key, value, ttl: default_ttl)
+      return SetResponse.from_block do
+        req = CacheClient::SetRequest.new(
+          cache_key: to_bytes(key),
+          cache_body: to_bytes(value),
+          ttl_milliseconds: ttl
+        )
+
+        cache_stub.set(req, metadata: { cache: cache_name })
+      end
+    end
+
+    # Delete a key in a cache.
+    #
+    # @param cache_name [String]
+    # @param key [String] must only contain ASCII characters
+    # @return [Momento::DeleteResponse]
+    def delete(cache_name, key)
+      return DeleteResponse.from_block do
+        cache_stub.delete(
+          CacheClient::DeleteRequest.new(cache_key: to_bytes(key)),
+          metadata: { cache: cache_name }
+        )
+      end
+    end
+
+    # Create a new Momento cache.
+    #
+    # @param name [String] the name of the cache to create.
+    # @return [Momento::CreateCacheResponse] the response from Momento.
+    def create_cache(name)
+      return CreateCacheResponse.from_block do
+        control_stub.create_cache(
+          ControlClient::CreateCacheRequest.new(cache_name: name)
+        )
+      end
+    end
+
+    # Delete an existing Momento cache.
+    #
+    # @param name [String] the name of the cache to delete.
+    # @return [Momento::DeleteCacheResponse] the response from Momento.
+    def delete_cache(name)
+      return DeleteCacheResponse.from_block do
+        control_stub.delete_cache(
+          ControlClient::DeleteCacheRequest.new(cache_name: name)
+        )
+      end
+    end
+
+    # List a page of your caches.
+    #
+    # The next_token indicates which page to fetch.
+    # If nil or "" it will fetch the first page. Default is to fetch the first page.
+    #
+    # @params next_token [String, nil] the token of the page to request
+    # @return [Momento::ListCachesResponse]
+    def list_caches(next_token: "")
+      return ListCachesResponse.from_block do
+        control_stub.list_caches(
+          ControlClient::ListCachesRequest.new(next_token: next_token)
+        )
+      end
+    end
+
+    # Lists the names of all your caches.
+    #
+    # @return [Enumerator::Lazy<String>] the cache names
+    # @raise [GRPC::BadStatus]
+    # rubocop:disable Metrics/MethodLength
+    def caches
+      Enumerator.new do |yielder|
+        next_token = ""
+
+        loop do
+          response = list_caches(next_token: next_token)
+          raise response.grpc_exception if response.is_a? Momento::Response::Error
+
+          response.cache_names.each do |name|
+            yielder << name
+          end
+
+          break if response.next_token == ''
+
+          next_token = response.next_token
+        end
+      end.lazy
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def cache_stub
+      @cache_stub ||= CACHE_CLIENT_STUB_CLASS.new(@cache_endpoint, combined_credentials)
+    end
+
+    def control_stub
+      @control_stub ||= CONTROL_CLIENT_STUB_CLASS.new(@control_endpoint, combined_credentials)
+    end
+
+    def combined_credentials
+      @combined_credentials ||= make_combined_credentials
+    end
+
+    def load_endpoints_from_token
+      claim = JWT.decode(@auth_token, nil, false).first
+
+      @control_endpoint = claim["cp"]
+      @cache_endpoint = claim["c"]
+    end
+
+    def make_combined_credentials
+      # :nocov:
+      auth_proc = proc do
+        { authorization: @auth_token, agent: "ruby:#{VERSION}" }
+      end
+      # :nocov:
+
+      call_creds = GRPC::Core::CallCredentials.new(auth_proc)
+
+      return GRPC::Core::ChannelCredentials.new.compose(call_creds)
+    end
+
+    # Ruby uses String for bytes. GRPC wants a String encoded as ASCII.
+    # GRPC will re-encode a String, but treats it as characters; GRPC will
+    # raise if you pass a String with non-ASCII characters.
+    # So we do the re-encoding ourselves in a way that treats the String as
+    # bytes and will not raise. The data is not changed.
+    #
+    # A duplicate String is returned, but since Ruby is copy-on-write it
+    # does not copy the data.
+    #
+    # @param string [String] the string to make safe for GRPC bytes
+    # @return [String] a duplicate safe to use as GRPC bytes
+    def to_bytes(string)
+      # dup in case the value is frozen and to avoid changing the value's encoding
+      # for the caller.
+      return string.dup.force_encoding(Encoding::ASCII_8BIT)
+    end
+  end
+end

data/lib/momento/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Momento
+  VERSION = "0.1.0"
+end

data/lib/momento.rb

@@ -0,0 +1,6 @@
+require_relative 'momento/version'
+require_relative 'momento/simple_cache_client'
+
+# Top level namespace for all Momento code.
+module Momento
+end

data/momento.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/momento/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "momento"
+  spec.version = Momento::VERSION
+  spec.authors = ["Momento"]
+  spec.email = ["eng-deveco@momentohq.com"]
+
+  spec.summary = "Client for Momento Serverless Cache"
+  spec.description = "Momento is a fast, simple, pay-as-you-go caching solution."
+  spec.homepage = "https://github.com/momentohq/client-sdk-ruby"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.license = "Apache-2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata["source_code_uri"] = "https://github.com/momentohq/client-sdk-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 2.3"
+  spec.add_development_dependency 'factory_bot', "~> 6.2.1"
+  spec.add_development_dependency 'faker', "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 3.18"
+  spec.add_development_dependency 'rubocop-performance', '~> 1.15'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.15'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+
+  spec.add_dependency "grpc", '~> 1'
+  spec.add_dependency 'jwt', '~> 2'
+end

data/sig/momento/client.rbs

@@ -0,0 +1,6 @@
+module Momento
+  module Client
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: momento
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Momento
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Momento is a fast, simple, pay-as-you-go caching solution.
+email:
+- eng-deveco@momentohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/basic.rb
+- lib/README-generating-pb.txt
+- lib/momento.rb
+- lib/momento/cacheclient_pb.rb
+- lib/momento/cacheclient_services_pb.rb
+- lib/momento/controlclient_pb.rb
+- lib/momento/controlclient_services_pb.rb
+- lib/momento/create_cache_response.rb
+- lib/momento/delete_cache_response.rb
+- lib/momento/delete_response.rb
+- lib/momento/get_response.rb
+- lib/momento/list_caches_response.rb
+- lib/momento/response.rb
+- lib/momento/response/error.rb
+- lib/momento/set_response.rb
+- lib/momento/simple_cache_client.rb
+- lib/momento/version.rb
+- momento.gemspec
+- sig/momento/client.rbs
+homepage: https://github.com/momentohq/client-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/momentohq/client-sdk-ruby
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/momentohq/client-sdk-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Client for Momento Serverless Cache
+test_files: []