momento 0.2.0 → 0.5.0

data/lib/momento/response/sorted_set/sorted_set_fetch_response.rb

@@ -0,0 +1,107 @@
+require_relative '../error'
+require_relative '../../generated/cacheclient_pb'
+
+module Momento
+  # A response containing the elements retrieved from a sorted set.
+  class SortedSetFetchResponse < Response
+    # The sorted set exists and any matching elements were fetched.
+    # @return [Boolean]
+    def hit?
+      false
+    end
+
+    # The sorted set does not exist.
+    # @return [Boolean]
+    def miss?
+      false
+    end
+
+    # The fetched values as UTF-8 Strings and their scores.
+    # @return [(Array[{ value: String, score: Float }] | nil)] the UTF-8 elements and their scores
+    def value_string_elements
+      nil
+    end
+
+    alias value value_string_elements
+
+    # The fetched values as ASCII_8BIT Strings and their scores.
+    # @return [(Array[{ value: String, score: Float }] | nil)] the ASCII_8BIT elements and their scores
+    def value_bytes_elements
+      nil
+    end
+
+    # @!method to_s
+    #   Displays the response and the value, if any.
+    #   A long value will be truncated.
+    #   @return [String]
+
+    # @private
+    class Hit < SortedSetFetchResponse
+      # rubocop:disable Lint/MissingSuper
+      def initialize(grpc_response:)
+        @grpc_response = grpc_response
+      end
+      # rubocop:enable Lint/MissingSuper
+
+      def hit?
+        true
+      end
+
+      def value_string_elements
+        @grpc_response.elements.map do |element|
+          { value: element.value.dup.force_encoding('UTF-8'), score: element.score }
+        end
+      end
+
+      alias value value_string_elements
+
+      def value_bytes_elements
+        @grpc_response.elements.map do |element|
+          { value: element.value, score: element.score }
+        end
+      end
+
+      def to_s
+        "#{super}: #{display_string(value_string)}"
+      end
+    end
+
+    # @private
+    class Miss < SortedSetFetchResponse
+      def miss?
+        true
+      end
+    end
+
+    # @private
+    class Error < SortedSetFetchResponse
+      include Momento::Response::Error
+    end
+  end
+
+  # @private
+  class SortedSetFetchResponseBuilder < ResponseBuilder
+    # Build a Momento::SortedSetFetchResponse from a block of code
+    # which returns a MomentoProtos::CacheClient::PB__SortedSetFetchResponse.
+    #
+    # @return [Momento::SortedSetFetchResponse]
+    # @raise [StandardError] when the exception is not recognized.
+    # @raise [TypeError] when the response is not recognized.
+    def from_block
+      response = yield
+    rescue *RESCUED_EXCEPTIONS => e
+      SortedSetFetchResponse::Error.new(exception: e, context: context)
+    else
+      raise TypeError unless response.is_a?(MomentoProtos::CacheClient::PB__SortedSetFetchResponse)
+
+      case response.sorted_set
+      when :found
+        SortedSetFetchResponse::Hit.new(grpc_response: response.found.values_with_scores)
+      when :missing
+        SortedSetFetchResponse::Miss.new
+      else
+        raise "Unknown sorted set fetch result: #{response.sorted_set}"
+      end
+    end
+  end
+end

data/lib/momento/response/sorted_set/sorted_set_put_element_response.rb

@@ -0,0 +1,44 @@
+require_relative '../error'
+require_relative '../../generated/cacheclient_pb'
+
+module Momento
+  # A response representing the result of a sorted set put element operation.
+  class SortedSetPutElementResponse < Response
+    # Was the element added to the sorted set?
+    # @return [Boolean]
+    def success?
+      false
+    end
+
+    # @private
+    class Success < SortedSetPutElementResponse
+      def success?
+        true
+      end
+    end
+
+    # @private
+    class Error < SortedSetPutElementResponse
+      include Momento::Response::Error
+    end
+  end
+
+  # @private
+  class SortedSetPutElementResponseBuilder < ResponseBuilder
+    # Build a Momento::SortedSetPutElementResponse from a block of code
+    # which returns a MomentoProtos::CacheClient::PB__SortedSetPutElementResponse.
+    #
+    # @return [Momento::SortedSetPutElementResponse]
+    # @raise [StandardError] when the exception is not recognized.
+    # @raise [TypeError] when the response is not recognized.
+    def from_block
+      response = yield
+    rescue *RESCUED_EXCEPTIONS => e
+      SortedSetPutElementResponse::Error.new(exception: e, context: context)
+    else
+      raise TypeError unless response.is_a?(::MomentoProtos::CacheClient::PB__SortedSetPutResponse)
+
+      SortedSetPutElementResponse::Success.new
+    end
+  end
+end

data/lib/momento/response/sorted_set/sorted_set_put_elements_response.rb

@@ -0,0 +1,44 @@
+require_relative '../error'
+require_relative '../../generated/cacheclient_pb'
+
+module Momento
+  # A response representing the result of a sorted set put elements operation.
+  class SortedSetPutElementsResponse < Response
+    # Were the elements added to the sorted set?
+    # @return [Boolean]
+    def success?
+      false
+    end
+
+    # @private
+    class Success < SortedSetPutElementsResponse
+      def success?
+        true
+      end
+    end
+
+    # @private
+    class Error < SortedSetPutElementsResponse
+      include Momento::Response::Error
+    end
+  end
+
+  # @private
+  class SortedSetPutElementsResponseBuilder < ResponseBuilder
+    # Build a Momento::SortedSetPutElementsResponse from a block of code
+    # which returns a MomentoProtos::CacheClient::PB__SortedSetPutElementsResponse.
+    #
+    # @return [Momento::SortedSetPutElementsResponse]
+    # @raise [StandardError] when the exception is not recognized.
+    # @raise [TypeError] when the response is not recognized.
+    def from_block
+      response = yield
+    rescue *RESCUED_EXCEPTIONS => e
+      SortedSetPutElementsResponse::Error.new(exception: e, context: context)
+    else
+      raise TypeError unless response.is_a?(::MomentoProtos::CacheClient::PB__SortedSetPutResponse)
+
+      SortedSetPutElementsResponse::Success.new
+    end
+  end
+end

data/lib/momento/version.rb

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

data/lib/momento.rb

@@ -1,5 +1,10 @@
 require_relative 'momento/version'
-require_relative 'momento/simple_cache_client'
+require_relative 'momento/cache_client'
+require_relative 'momento/collection_ttl'
+require_relative 'momento/auth/credential_provider'
+require_relative 'momento/config/configuration'
+require_relative 'momento/config/configurations'
+require_relative 'momento/response/sort_order'
 
 # Top level namespace for all Momento code.
 module Momento

data/momento.gemspec

@@ -32,14 +32,16 @@ Gem::Specification.new do |spec|
   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 'jwt', '~> 2'
+  spec.add_development_dependency 'pry-byebug', '~> 3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency "rspec", "~> 3.12"
-  spec.add_development_dependency "rubocop", "~> 3.18"
+  spec.add_development_dependency "rubocop", "~> 1.38"
   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_development_dependency 'yard', '~> 0.9'
 
-  spec.add_dependency "grpc", '~> 1'
-  spec.add_dependency 'jwt', '~> 2'
+  spec.add_dependency "grpc", '~> 1.62'
 end

data/release-please-config.json

@@ -8,7 +8,7 @@
       "draft": false,
       "prerelease": false,
       "package-name": "momento",
-      "bootstrap-sha": "ddb1cf2711fc1c7a29c0b48fe7f3aa12527c528c"
+      "bootstrap-sha": "dd1ff65ceee97237bc75f75477cda6243df5c9e8"
     }
   },
   "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"

data/sig/momento/auth/credential_provider.rbs

@@ -0,0 +1,11 @@
+module Momento
+  class CredentialProvider
+    def self.from_env_var: -> CredentialProvider
+
+    def self.from_string: -> CredentialProvider
+
+    attr_reader api_key: String
+    attr_reader cache_endpoint: String
+    attr_reader control_endpoint: String
+  end
+end

data/sig/momento/cache_client.rbs

@@ -0,0 +1,11 @@
+module Momento
+  class CacheClient
+    def sorted_set_fetch_by_score: (cache_name: String, sorted_set_name: String, min_score: Float | nil, max_score: Float | nil, sort_order: Symbol, offset: Integer, count: Integer) -> SortedSetFetchResponse
+
+    def sorted_set_put_element: (cache_name: String, sorted_set_name: String, value: String, score: Float, collection_ttl: CollectionTtl) -> SortedSetPutElementResponse
+
+    type value_score_pair = [String, Float]
+    type value_score_hash = { value: String, score: Float }
+    def sorted_set_put_elements: (cache_name: String, sorted_set_name: String, elements: (Hash[String, Float] | Array[value_score_pair] | Array[value_score_hash]), collection_ttl: CollectionTtl) -> SortedSetPutElementsResponse
+  end
+end

data/sig/momento/collection_ttl.rbs

@@ -0,0 +1,22 @@
+module Momento
+  class CollectionTtl
+    def self.from_cache_ttl: -> CollectionTtl
+
+    def self.of: -> CollectionTtl
+
+    def self.refresh_ttl_if_provided: -> CollectionTtl
+
+    attr_reader refresh_ttl: bool
+    attr_reader ttl_seconds: (Integer | nil)
+
+    def initialize: (ttl_seconds: (Integer | nil), refresh_ttl: bool) -> CollectionTtl
+
+    def ttl_milliseconds: -> (Integer | nil)
+
+    def with_no_refresh_ttl_on_updates: -> CollectionTtl
+
+    def with_refresh_ttl_on_updates: -> CollectionTtl
+
+    def with_ttl_if_absent: -> CollectionTtl
+  end
+end

data/sig/momento/config/configuration.rbs

@@ -0,0 +1,13 @@
+module Momento
+  module Cache
+    class Configuration
+      def with_timeout: -> Configuration
+
+      def with_num_connections: -> Configuration
+
+      def with_transport_strategy: -> Configuration
+
+      attr_reader transport_strategy: TransportStrategy
+    end
+  end
+end

data/sig/momento/config/configurations.rbs

@@ -0,0 +1,9 @@
+module Momento
+  module Cache
+    module Configurations
+      class Laptop
+        self.latest: -> Cache::Configuration
+      end
+    end
+  end
+end

data/sig/momento/config/transport/grpc_configuration.rbs

@@ -0,0 +1,9 @@
+module Momento
+  class GrpcConfiguration
+    def self.with_deadline: -> GrpcConfiguration
+
+    def self.with_num_grpc_channels: -> GrpcConfiguration
+
+    attr_reader deadline: Integer
+  end
+end

data/sig/momento/config/transport/transport_strategy.rbs

@@ -0,0 +1,7 @@
+module Momento
+  class TransportStrategy
+    def self.with_grpc_configuration: -> TransportStrategy
+
+    attr_reader grpc_configuration: GrpcConfiguration
+  end
+end

data/sig/momento/list_caches_response.rbs

@@ -0,0 +1,7 @@
+module Momento
+  class ListCachesResponse
+    def success?: -> bool
+
+    def cache_names: -> (Array[String] | nil)
+  end
+end

data/sig/momento/sorted_set_fetch_response.rbs

@@ -0,0 +1,13 @@
+module Momento
+  class SortedSetFetchResponse
+    def hit?: -> bool
+
+    def miss?: -> bool
+
+    alias value value_string_elements
+
+    def value_bytes_elements: -> (Array[{ value: String, score: Float }] | nil)
+
+    def value_string_elements: -> (Array[{ value: String, score: Float }] | nil)
+  end
+end

data/sig/momento/sorted_set_put_element_response.rbs

@@ -0,0 +1,5 @@
+module Momento
+  class SortedSetPutElementResponse
+    def success?: -> bool
+  end
+end

data/sig/momento/sorted_set_put_elements_response.rbs

@@ -0,0 +1,5 @@
+module Momento
+  class SortedSetPutElementsResponse
+    def success?: -> bool
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momento
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Momento
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '1.38'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '1.38'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.62'
   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'
+        version: '1.62'
 description: Momento is a fast, simple, pay-as-you-go caching solution.
 email:
 - eng-deveco@momentohq.com
@@ -207,37 +235,70 @@ files:
 - examples/file.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/create_cache_response_builder.rb
-- lib/momento/delete_cache_response.rb
-- lib/momento/delete_cache_response_builder.rb
-- lib/momento/delete_response.rb
-- lib/momento/delete_response_builder.rb
+- lib/momento/auth/credential_provider.rb
+- lib/momento/cache_client.rb
+- lib/momento/collection_ttl.rb
+- lib/momento/config/configuration.rb
+- lib/momento/config/configurations.rb
+- lib/momento/config/transport/grpc_configuration.rb
+- lib/momento/config/transport/static_transport_strategy.rb
+- lib/momento/config/transport/transport_strategy.rb
 - lib/momento/error.rb
 - lib/momento/error/grpc_details.rb
 - lib/momento/error/transport_details.rb
 - lib/momento/error/types.rb
 - lib/momento/error_builder.rb
 - lib/momento/exceptions.rb
-- lib/momento/get_response.rb
-- lib/momento/get_response_builder.rb
-- lib/momento/list_caches_response.rb
-- lib/momento/list_caches_response_builder.rb
-- lib/momento/response.rb
+- lib/momento/generated/README.md
+- lib/momento/generated/auth_pb.rb
+- lib/momento/generated/auth_services_pb.rb
+- lib/momento/generated/cacheclient_pb.rb
+- lib/momento/generated/cacheclient_services_pb.rb
+- lib/momento/generated/cacheping_pb.rb
+- lib/momento/generated/cacheping_services_pb.rb
+- lib/momento/generated/cachepubsub_pb.rb
+- lib/momento/generated/cachepubsub_services_pb.rb
+- lib/momento/generated/common_pb.rb
+- lib/momento/generated/controlclient_pb.rb
+- lib/momento/generated/controlclient_services_pb.rb
+- lib/momento/generated/extensions_pb.rb
+- lib/momento/generated/generate_protos.sh
+- lib/momento/generated/leaderboard_pb.rb
+- lib/momento/generated/leaderboard_services_pb.rb
+- lib/momento/generated/permissionmessages_pb.rb
+- lib/momento/generated/token_pb.rb
+- lib/momento/generated/token_services_pb.rb
+- lib/momento/generated/webhook_pb.rb
+- lib/momento/generated/webhook_services_pb.rb
+- lib/momento/response/control/create_cache_response.rb
+- lib/momento/response/control/delete_cache_response.rb
+- lib/momento/response/control/list_caches_response.rb
+- lib/momento/response/delete_response.rb
 - lib/momento/response/error.rb
-- lib/momento/response_builder.rb
-- lib/momento/set_response.rb
-- lib/momento/set_response_builder.rb
-- lib/momento/simple_cache_client.rb
+- lib/momento/response/get_response.rb
+- lib/momento/response/response.rb
+- lib/momento/response/response_builder.rb
+- lib/momento/response/set_response.rb
+- lib/momento/response/sort_order.rb
+- lib/momento/response/sorted_set/sorted_set_fetch_response.rb
+- lib/momento/response/sorted_set/sorted_set_put_element_response.rb
+- lib/momento/response/sorted_set/sorted_set_put_elements_response.rb
 - lib/momento/ttl.rb
 - lib/momento/version.rb
 - momento.gemspec
 - release-please-config.json
+- sig/momento/auth/credential_provider.rbs
+- sig/momento/cache_client.rbs
 - sig/momento/client.rbs
+- sig/momento/collection_ttl.rbs
+- sig/momento/config/configuration.rbs
+- sig/momento/config/configurations.rbs
+- sig/momento/config/transport/grpc_configuration.rbs
+- sig/momento/config/transport/transport_strategy.rbs
+- sig/momento/list_caches_response.rbs
+- sig/momento/sorted_set_fetch_response.rbs
+- sig/momento/sorted_set_put_element_response.rbs
+- sig/momento/sorted_set_put_elements_response.rbs
 homepage: https://github.com/momentohq/client-sdk-ruby
 licenses:
 - Apache-2.0
@@ -260,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Client for Momento Serverless Cache