momento 0.1.0 → 0.4.9

data/lib/momento/{delete_cache_response.rb → response/control/delete_cache_response.rb}

@@ -1,39 +1,46 @@
-require 'grpc'
-require 'momento/controlclient_pb'
+require_relative '../error'
+require_relative '../../generated/controlclient_pb'
 
 module Momento
-  # Responses specific to delete_cache
+  # A response from deleting a cache.
   class DeleteCacheResponse < Response
-    # Build a Momento::DeleteCacheResponse from a block of code
-    # which returns a Momento::ControlClient::DeleteCacheResponse..
-    #
-    # @return [Momento::DeleteCacheResponse]
-    # @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::DeleteCacheResponse)
-
-      return Success.new
-    end
-
+    # Was the cache deleted?
+    # @return [Boolean]
     def success?
       false
     end
 
-    # There was an error deleting the cache.
+    # @private
     class Error < DeleteCacheResponse
       include ::Momento::Response::Error
     end
 
-    # The cache was deleted.
+    # @private
     class Success < DeleteCacheResponse
       def success?
         true
       end
     end
   end
+
+  # @private
+  class DeleteCacheResponseBuilder < ResponseBuilder
+    # Build a Momento::DeleteCacheResponse from a block of code
+    # which returns a Momento::ControlClient::DeleteCacheResponse..
+    #
+    # @return [Momento::DeleteCacheResponse]
+    # @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
+      DeleteCacheResponse::Error.new(
+        exception: e, context: context
+      )
+    else
+      raise TypeError unless response.is_a?(::MomentoProtos::ControlClient::PB__DeleteCacheResponse)
+
+      return DeleteCacheResponse::Success.new
+    end
+  end
 end

data/lib/momento/response/control/list_caches_response.rb

@@ -0,0 +1,80 @@
+require_relative '../error'
+require_relative '../../generated/controlclient_pb'
+
+module Momento
+  # A response from listing the caches.
+  class ListCachesResponse < Response
+    # Did it get a list of caches?
+    # @return [Boolean]
+    def success?
+      false
+    end
+
+    # The names of the caches.
+    # @return [Array,nil]
+    def cache_names
+      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 to_s
+        "#{super}: #{display_cache_names}"
+      end
+
+      private
+
+      def display_cache_names
+        display = cache_names&.take(CACHE_NAMES_TO_DISPLAY)&.join(", ")
+        cache_names&.size&.>(CACHE_NAMES_TO_DISPLAY) ? "#{display}, ..." : display.to_s
+      end
+    end
+
+    # @private
+    class Error < ListCachesResponse
+      include ::Momento::Response::Error
+    end
+  end
+
+  # @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?(::MomentoProtos::ControlClient::PB__ListCachesResponse)
+
+      return ListCachesResponse::Success.new(grpc_response: response)
+    end
+  end
+end

data/lib/momento/response/delete_response.rb

@@ -0,0 +1,45 @@
+require_relative 'error'
+require 'grpc'
+require_relative '../generated/cacheclient_pb'
+
+module Momento
+  # A response from deleting a key.
+  class DeleteResponse < Response
+    # Was the key deleted?
+    # @return [Boolean]
+    def success?
+      false
+    end
+
+    # @private
+    class Success < DeleteResponse
+      def success?
+        true
+      end
+    end
+
+    # @private
+    class Error < DeleteResponse
+      include Momento::Response::Error
+    end
+  end
+
+  # @private
+  class DeleteResponseBuilder < ResponseBuilder
+    # Build a Momento::DeleteResponse from a block of code
+    # which returns a Momento::CacheClient::DeleteResponse..
+    #
+    # @return [Momento::DeleteResponse]
+    # @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
+      DeleteResponse::Error.new(exception: e, context: context)
+    else
+      raise TypeError unless response.is_a?(::MomentoProtos::CacheClient::PB__DeleteResponse)
+
+      DeleteResponse::Success.new
+    end
+  end
+end

data/lib/momento/response/error.rb

@@ -1,16 +1,23 @@
 module Momento
   class Response
     # A module for responses which contain errors.
+    # @private
     module Error
-      attr_accessor :grpc_exception
+      attr_reader :error
 
-      def initialize(grpc_exception:)
-        @grpc_exception = grpc_exception
+      def initialize(exception:, context: {})
+        @error = Momento::ErrorBuilder.from_exception(
+          exception, context: context
+        ).freeze
       end
 
       def error?
         true
       end
+
+      def to_s
+        "#{super}: #{error.message}"
+      end
     end
   end
 end

data/lib/momento/response/get_response.rb

@@ -0,0 +1,107 @@
+require_relative 'error'
+require_relative '../generated/cacheclient_pb'
+
+module Momento
+  # A response containing the value retrieved from a cache.
+  class GetResponse < Response
+    # There was a value for the key.
+    # @return [Boolean]
+    def hit?
+      false
+    end
+
+    # There was no value for the key.
+    # @return [Boolean]
+    def miss?
+      false
+    end
+
+    # The gotten value, if any, as binary data: an ASCII_8BIT encoded frozen String.
+    #
+    # @return [String,nil] the value, if any, frozen and ASCII_8BIT encoded
+    def value_bytes
+      nil
+    end
+
+    # The gotten value, if any, as a UTF-8 string.
+    #
+    # @return [String,nil] the value, if any.
+    def value_string
+      nil
+    end
+
+    # @!method to_s
+    #   Displays the response and the value, if any.
+    #   A long value will be truncated.
+    #   @return [String]
+
+    # @private
+    class Hit < GetResponse
+      # rubocop:disable Lint/MissingSuper
+      def initialize(grpc_response:)
+        @grpc_response = grpc_response
+      end
+      # rubocop:enable Lint/MissingSuper
+
+      def hit?
+        true
+      end
+
+      def value_bytes
+        @grpc_response.cache_body
+      end
+
+      def value_string
+        value_bytes.dup.force_encoding('UTF-8')
+      end
+
+      def to_s
+        "#{super}: #{display_string(value_string)}"
+      end
+    end
+
+    # @private
+    class Miss < GetResponse
+      def miss?
+        true
+      end
+    end
+
+    # @private
+    class Error < GetResponse
+      include Momento::Response::Error
+    end
+  end
+
+  # @private
+  class GetResponseBuilder < ResponseBuilder
+    # 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 *RESCUED_EXCEPTIONS => e
+      GetResponse::Error.new(exception: e, context: context)
+    else
+      from_response(response)
+    end
+
+    private
+
+    def from_response(response)
+      raise TypeError unless response.is_a?(MomentoProtos::CacheClient::PB__GetResponse)
+
+      case response.result
+      when :Hit
+        GetResponse::Hit.new(grpc_response: response)
+      when :Miss
+        GetResponse::Miss.new
+      else
+        raise "Unknown get result: #{response.result}"
+      end
+    end
+  end
+end

data/lib/momento/response/response.rb

@@ -0,0 +1,67 @@
+require 'grpc'
+require_relative 'error'
+require_relative '../error'
+require_relative '../error/grpc_details'
+require_relative '../error/transport_details'
+require_relative '../error_builder'
+require_relative 'response_builder'
+require_relative 'control/create_cache_response'
+require_relative 'delete_response'
+require_relative 'control/delete_cache_response'
+require_relative 'get_response'
+require_relative 'control/list_caches_response'
+require_relative 'set_response'
+require_relative 'sorted_set/sorted_set_put_element_response'
+require_relative 'sorted_set/sorted_set_put_elements_response'
+require_relative 'sorted_set/sorted_set_fetch_response'
+
+module Momento
+  # The response from a Momento service request.
+  #
+  # {Momento::CacheClient} returns a response for both success
+  # and error, as well as other states. See the documenation for each
+  # type of response for more.
+  #
+  # You can always check for an error response with
+  # `response.error?` and get the error itself with `response.error`.
+  #
+  # `response.error` is an Exception and can be raised. It contains
+  # additional information about the error, see {Momento::Error} for
+  # more information.
+  #
+  # @see Momento::Error
+  class Response
+    MAX_STRING_DISPLAY_LENGTH = 32
+    private_constant :MAX_STRING_DISPLAY_LENGTH
+
+    # Returns the error portion of the response, if any.
+    #
+    # @return [Momento::Error, nil]
+    def error
+      nil
+    end
+
+    # Is the response an error?
+    #
+    # @return [Boolean]
+    def error?
+      false
+    end
+
+    # Displays the type of response and additional info, if any.
+    # @return [String]
+    def to_s
+      self.class.to_s
+    end
+
+    protected
+
+    def display_string(string, max_length: MAX_STRING_DISPLAY_LENGTH)
+      if string.length < max_length
+        string
+      else
+        "#{string[0, max_length]}..."
+      end
+    end
+  end
+end

data/lib/momento/response/response_builder.rb

@@ -0,0 +1,18 @@
+module Momento
+  # A superclass for building responses.
+  #
+  # @private
+  class ResponseBuilder
+    attr_accessor :context
+
+    RESCUED_EXCEPTIONS = ErrorBuilder::EXCEPTION_MAP.keys.freeze
+
+    def initialize(context: {})
+      @context = context
+    end
+
+    def from_block
+      raise NotImplementedError
+    end
+  end
+end

data/lib/momento/response/set_response.rb

@@ -0,0 +1,59 @@
+require_relative 'error'
+require_relative '../generated/cacheclient_pb'
+
+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
+
+  # @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?(::MomentoProtos::CacheClient::PB__SetResponse)
+
+      SetResponse::Success.new(key: context[:key], value: context[:value])
+    end
+  end
+end

data/lib/momento/response/sort_order.rb

@@ -0,0 +1,11 @@
+module Momento
+  # Represents whether a collection is sorted in ascending or descending fashion.
+  class SortOrder
+    ASCENDING = :ascending
+    DESCENDING = :descending
+
+    def self.valid?(order)
+      [ASCENDING, DESCENDING].include?(order)
+    end
+  end
+end

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