momento 0.2.0 → 0.5.0

data/lib/momento/list_caches_response.rb

@@ -1,77 +0,0 @@
-require_relative 'response/error'
-
-module Momento
-  # A response from listing the caches.
-  #
-  # Each response is a single page of caches, there may be additional pages.
-  # Use Momento::SimpleCacheClient#caches to efficiently get the whole list.
-  class ListCachesResponse < Response
-    # Did it get a page of caches?
-    # @return [Boolean]
-    def success?
-      false
-    end
-
-    # The names of the caches in this page.
-    # @return [Array,nil]
-    def cache_names
-      nil
-    end
-
-    # A token to fetch the next page.
-    # The last page will have a blank token.
-    # @return [String,nil]
-    def next_token
-      nil
-    end
-
-    # @!method to_s
-    #   Displays the response and the list of cache names.
-    #   The list of cache names will be truncated.
-    #   @return [String]
-
-    # @private
-    class Success < ListCachesResponse
-      CACHE_NAMES_TO_DISPLAY = 5
-
-      # 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
-
-      def to_s
-        "#{super}: #{display_cache_names}"
-      end
-
-      private
-
-      def display_cache_names
-        display = cache_names.first(CACHE_NAMES_TO_DISPLAY).join(", ")
-
-        if cache_names.size > CACHE_NAMES_TO_DISPLAY
-          "#{display}, ..."
-        else
-          display
-        end
-      end
-    end
-
-    # @private
-    class Error < ListCachesResponse
-      include ::Momento::Response::Error
-    end
-  end
-end

data/lib/momento/list_caches_response_builder.rb

@@ -1,25 +0,0 @@
-require 'grpc'
-require_relative 'controlclient_pb'
-
-module Momento
-  # @private
-  class ListCachesResponseBuilder < ResponseBuilder
-    # 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 from_block
-      response = yield
-    rescue GRPC::BadStatus => e
-      ListCachesResponse::Error.new(
-        exception: e, context: context
-      )
-    else
-      raise TypeError unless response.is_a?(::Momento::ControlClient::ListCachesResponse)
-
-      return ListCachesResponse::Success.new(grpc_response: response)
-    end
-  end
-end

data/lib/momento/set_response.rb

@@ -1,39 +0,0 @@
-require_relative 'response/error'
-
-module Momento
-  # A response from setting a key.
-  class SetResponse < Response
-    # Was the key/value pair added to the cache?
-    # @return [Boolean]
-    def success?
-      false
-    end
-
-    # @private
-    class Success < SetResponse
-      attr_accessor :key, :value
-
-      # rubocop:disable Lint/MissingSuper
-      def initialize(key:, value:)
-        @key = key
-        @value = value
-
-        return
-      end
-      # rubocop:enable Lint/MissingSuper
-
-      def success?
-        true
-      end
-
-      def to_s
-        "#{super}: '#{display_string(key)}' = '#{display_string(value)}'"
-      end
-    end
-
-    # @private
-    class Error < SetResponse
-      include Momento::Response::Error
-    end
-  end
-end

data/lib/momento/set_response_builder.rb

@@ -1,25 +0,0 @@
-require 'grpc'
-require_relative 'cacheclient_pb'
-
-module Momento
-  # Builds SetResponses
-  #
-  # @private
-  class SetResponseBuilder < ResponseBuilder
-    # Build a Momento::SetResponse from a block of code
-    # which returns a Momento::CacheClient::SetResponse..
-    #
-    # @return [Momento::SetResponse]
-    # @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
-      SetResponse::Error.new(exception: e, context: context)
-    else
-      raise TypeError unless response.is_a?(::Momento::CacheClient::SetResponse)
-
-      SetResponse::Success.new(key: context[:key], value: context[:value])
-    end
-  end
-end

data/lib/momento/simple_cache_client.rb

@@ -1,336 +0,0 @@
-require 'jwt'
-require_relative 'cacheclient_services_pb'
-require_relative 'controlclient_services_pb'
-require_relative 'response'
-require_relative 'ttl'
-require_relative 'exceptions'
-
-module Momento
-  # rubocop:disable Metrics/ClassLength
-
-  # A simple client for Momento.
-  #
-  # SimpleCacheClient does not use exceptions to report errors.
-  # Instead it returns an error response. Please see {file:README.md#label-Error+Handling}.
-  #
-  # @example
-  #   token = ...your Momento JWT...
-  #   client = Momento::SimpleCacheClient.new(
-  #     auth_token: token,
-  #     # cached items will be deleted after 100 seconds
-  #     default_ttl: 100
-  #   )
-  #
-  #   response = client.create_cache("my_cache")
-  #   if response.success?
-  #     puts "my_cache was created"
-  #   elsif response.already_exists?
-  #     puts "my_cache already exists"
-  #   elsif response.error?
-  #     raise response.error
-  #   end
-  #
-  #   # set will only return success or error,
-  #   # we only need to check for error
-  #   response = client.set("my_cache", "key", "value")
-  #   raise response.error if response.error?
-  #
-  #   response = client.get("my_cache", "key")
-  #   if response.hit?
-  #     puts "We got #{response.value_string}"
-  #   elsif response.miss?
-  #     puts "It's not in the cache"
-  #   elsif response.error?
-  #     raise response.error
-  #   end
-  #
-  # @see Momento::Response
-  class SimpleCacheClient
-    # This gem's version.
-    VERSION = Momento::VERSION
-    CACHE_CLIENT_STUB_CLASS = CacheClient::Scs::Stub
-    CONTROL_CLIENT_STUB_CLASS = ControlClient::ScsControl::Stub
-    private_constant :CACHE_CLIENT_STUB_CLASS, :CONTROL_CLIENT_STUB_CLASS
-
-    # @return [Numeric] how long items should remain in the cache, in seconds.
-    attr_accessor :default_ttl
-
-    # @param auth_token [String] the JWT for your Momento account
-    # @param default_ttl [Numeric] time-to-live, in seconds
-    # @raise [ArgumentError] if the default_ttl or auth_token is invalid
-    def initialize(auth_token:, default_ttl:)
-      @auth_token = auth_token
-      @default_ttl = Momento::Ttl.to_ttl(default_ttl)
-      load_endpoints_from_token
-    end
-
-    # Get a value in a cache.
-    #
-    # The value can be retrieved as either bytes or a string.
-    # @example
-    #   response = client.get("my_cache", "key")
-    #   if response.hit?
-    #     puts "We got #{response.value_string}"
-    #   elsif response.miss?
-    #     puts "It's not in the cache"
-    #   elsif response.error?
-    #     raise response.error
-    #   end
-    #
-    # @see Momento::GetResponse
-    # @param cache_name [String]
-    # @param key [String] must only contain ASCII characters
-    # @return [Momento::GetResponse]
-    # @raise [TypeError] when the cache_name or key is not a String
-    def get(cache_name, key)
-      builder = GetResponseBuilder.new(
-        context: { cache_name: cache_name, key: key }
-      )
-
-      return builder.from_block do
-        validate_cache_name(cache_name)
-
-        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.
-    # @example
-    #   response = client.set("my_cache", "key", "value")
-    #   raise response.error if response.error?
-    #
-    # @see Momento::SetResponse
-    # @param cache_name [String]
-    # @param key [String] must only contain ASCII characters
-    # @param value [String] the value to cache
-    # @param ttl [Numeric] time-to-live, in seconds.
-    # @raise [ArgumentError] if the ttl is invalid
-    # @return [Momento::SetResponse]
-    # @raise [TypeError] when the cache_name, key, or value is not a String
-    def set(cache_name, key, value, ttl: default_ttl)
-      ttl = Momento::Ttl.to_ttl(ttl)
-
-      builder = SetResponseBuilder.new(
-        context: { cache_name: cache_name, key: key, value: value, ttl: ttl }
-      )
-
-      return builder.from_block do
-        validate_cache_name(cache_name)
-
-        req = CacheClient::SetRequest.new(
-          cache_key: to_bytes(key),
-          cache_body: to_bytes(value),
-          ttl_milliseconds: ttl.milliseconds
-        )
-
-        cache_stub.set(req, metadata: { cache: cache_name })
-      end
-    end
-
-    # Delete a key in a cache.
-    #
-    # If the key does not exist, delete will still succeed.
-    # @example
-    #   response = client.delete("my_cache", "key")
-    #   raise response.error if response.error?
-    #
-    # @see Momento::DeleteResponse
-    # @param cache_name [String]
-    # @param key [String] must only contain ASCII characters
-    # @return [Momento::DeleteResponse]
-    # @raise [TypeError] when the cache_name or key is not a String
-    def delete(cache_name, key)
-      builder = DeleteResponseBuilder.new(
-        context: { cache_name: cache_name, key: key }
-      )
-
-      return builder.from_block do
-        validate_cache_name(cache_name)
-
-        cache_stub.delete(
-          CacheClient::DeleteRequest.new(cache_key: to_bytes(key)),
-          metadata: { cache: cache_name }
-        )
-      end
-    end
-
-    # Create a new Momento cache.
-    # @example
-    #   response = client.create_cache("my_cache")
-    #   if response.success?
-    #     puts "my_cache was created"
-    #   elsif response.already_exists?
-    #     puts "my_cache already exists"
-    #   elsif response.error?
-    #     raise response.error
-    #   end
-    #
-    # @see Momento::CreateCacheResponse
-    # @param cache_name [String] the name of the cache to create.
-    # @return [Momento::CreateCacheResponse] the response from Momento.
-    # @raise [TypeError] when the cache_name is not a String
-    def create_cache(cache_name)
-      builder = CreateCacheResponseBuilder.new(
-        context: { cache_name: cache_name }
-      )
-
-      return builder.from_block do
-        validate_cache_name(cache_name)
-
-        control_stub.create_cache(
-          ControlClient::CreateCacheRequest.new(cache_name: cache_name)
-        )
-      end
-    end
-
-    # Delete an existing Momento cache.
-    #
-    # @example
-    #   response = client.delete_cache("my_cache")
-    #   raise response.error if response.error?
-    #
-    # @see Momento::DeleteCacheResponse
-    # @param cache_name [String] the name of the cache to delete.
-    # @return [Momento::DeleteCacheResponse] the response from Momento.
-    # @raise [TypeError] when the cache_name is not a String
-    def delete_cache(cache_name)
-      builder = DeleteCacheResponseBuilder.new(
-        context: { cache_name: cache_name }
-      )
-
-      return builder.from_block do
-        validate_cache_name(cache_name)
-
-        control_stub.delete_cache(
-          ControlClient::DeleteCacheRequest.new(cache_name: cache_name)
-        )
-      end
-    end
-
-    # List a page of your caches.
-    #
-    # This is a low-level method. You probably want to use {#caches} instead.
-    #
-    # The next_token indicates which page to fetch.
-    # If nil or "" it will fetch the first page. Default is to fetch the first page.
-    #
-    # @see #caches
-    # @see Momento::ListCachesResponse
-    # @note Consider using `caches` instead.
-    # @param next_token [String, nil] the token of the page to request
-    # @return [Momento::ListCachesResponse]
-    def list_caches(next_token: "")
-      builder = ListCachesResponseBuilder.new(
-        context: { next_token: next_token }
-      )
-      return builder.from_block do
-        control_stub.list_caches(
-          ControlClient::ListCachesRequest.new(next_token: next_token)
-        )
-      end
-    end
-
-    # Lists the names of all your caches, as a lazy Enumerator.
-    # @example
-    #   cache_names = client.caches
-    #   cache_names.each { |name| puts name }
-    #
-    # @note Unlike other methods, this will raise if there is a problem
-    #   with the client or service.
-    # @return [Enumerator::Lazy<String>] the cache names
-    # @raise [Momento::Error] when there is an error listing caches.
-    def caches
-      Enumerator.new do |yielder|
-        next_token = ""
-
-        loop do
-          response = list_caches(next_token: next_token)
-          raise response.error 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
-
-    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"]
-    rescue JWT::DecodeError
-      raise ArgumentError, "Invalid Momento auth token."
-    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
-    # @raise [TypeError] when the string is not a String
-    def to_bytes(string)
-      raise TypeError, "expected a String, got a #{string.class}" unless string.is_a?(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
-
-    # This is not a complete validation of the cache name, just
-    # issues that might cause an exception in the client. Let the server
-    # handle the rest of the validation.
-    #
-    # @param name [String] the cache name to validate
-    # @raise [TypeError] when the name is not a String
-    # @raise [Momento::CacheNameError] when the name is not ASCII
-    def validate_cache_name(name)
-      raise TypeError, "Cache name must be a String, got a #{name.class}" unless name.is_a?(String)
-      raise Momento::CacheNameError, "Cache name must be ASCII, got '#{name}'" if name.match?(/[^[:ascii:]]/)
-
-      return
-    end
-  end
-  # rubocop:enable Metrics/ClassLength
-end