momento 0.1.0 → 0.4.9

data/lib/momento/ttl.rb

@@ -0,0 +1,48 @@
+module Momento
+  # Validates and represents a time-to-live.
+  #
+  # @private
+  class Ttl
+    class << self
+      # Create a Momento::Ttl object.
+      #
+      # If given a Momento::Ttl it will return it.
+      # This means you don't have to check if it's already a Momento::Ttl
+      #
+      # @example
+      #   ttl = Momento::Ttl.to_ttl(ttl)
+      # @param ttl [Numeric,Momento::Ttl] the TTL in seconds, or an existing Ttl object
+      # @return [Momento::Ttl]
+      def to_ttl(ttl)
+        return ttl if ttl.is_a?(self)
+
+        raise ArgumentError, "ttl '#{ttl}' is not Numeric" unless ttl.is_a?(Numeric)
+        raise ArgumentError, "ttl #{ttl} is less than 0" if ttl.negative?
+
+        new(ttl)
+      end
+    end
+
+    # @return [Numeric] the TTL in seconds
+    attr_reader :seconds
+
+    def initialize(ttl)
+      @seconds = ttl
+    end
+
+    # @return [Numeric] the TTL in milliseconds
+    def milliseconds
+      @seconds * 1_000
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Momento::Ttl)
+
+      milliseconds == other.milliseconds
+    end
+
+    def to_s
+      "#{seconds} seconds"
+    end
+  end
+end

data/lib/momento/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Momento
-  VERSION = "0.1.0"
+  # This gem's version.
+  VERSION = "0.4.9"
 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,13 +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

@@ -0,0 +1,15 @@
+{
+  "packages": {
+    ".": {
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "ruby",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": false,
+      "prerelease": false,
+      "package-name": "momento",
+      "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,12 @@
+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,9 @@
+module Momento
+  module Cache
+    class Configuration
+      def self.with_transport_strategy: -> Cache::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,7 @@
+module Momento
+  class GrpcConfiguration
+    def self.with_deadline: -> 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.1.0
+  version: 0.4.9
 platform: ruby
 authors:
 - Momento
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2024-04-30 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
@@ -137,33 +179,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: grpc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
+        version: '0.9'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: jwt
+  name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.62'
   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
@@ -172,34 +214,91 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.template.md
 - Rakefile
-- examples/basic.rb
+- examples/.gitignore
+- examples/Gemfile
+- examples/README.md
+- examples/compact.rb
+- examples/example.rb
+- 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/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/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/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/set_response.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
@@ -207,7 +306,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +321,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Client for Momento Serverless Cache
 test_files: []

data/examples/basic.rb

@@ -1,45 +0,0 @@
-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