momento 0.1.0 → 0.4.9

data/lib/momento/error/types.rb

@@ -0,0 +1,247 @@
+module Momento
+  module Error
+    # rubocop:disable Layout/LineLength
+
+    # A cache with the specified name already exists.
+    class AlreadyExistsError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :ALREADY_EXISTS_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "A cache with the specified name already exists.  To resolve this error, either delete the existing cache and make a new one, or use a different name.  Cache name: '#{context[:cache_name]}'"
+      end
+    end
+
+    # Invalid authentication credentials to connect to cache service
+    class AuthenticationError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :AUTHENTICATION_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "Invalid authentication credentials to connect to cache service: #{details}"
+      end
+    end
+
+    # The request was invalid.
+    class BadRequestError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :BAD_REQUEST_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "The request was invalid; please contact Momento: #{details}"
+      end
+    end
+
+    # The request was cancelled by the server.
+    class CancelledError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :CANCELLED_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "The request was cancelled by the server; please contact Momento: #{details}"
+      end
+    end
+
+    # A client resource (most likely memory) was exhausted.
+    class ClientResourceExhaustedError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :CLIENT_RESOURCE_EXHAUSTED
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "A client resource (most likely memory) was exhausted.  If you are executing a high volume of concurrent requests or using very large object sizes, your Configuration may need to be updated to allocate more memory.  Please contact Momento for assistance."
+      end
+    end
+
+    # Error connecting to Momento servers.
+    class ConnectionError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :CONNECTION_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "Error connecting to Momento servers."
+      end
+    end
+
+    # System is not in a state required for the operation\'s execution
+    class FailedPreconditionError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :FAILED_PRECONDITION_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "System is not in a state required for the operation's execution"
+      end
+    end
+
+    # An unexpected error occurred while trying to fulfill the request.
+    class InternalServerError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :INTERNAL_SERVER_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "An unexpected error occurred while trying to fulfill the request; please contact Momento: #{details}"
+      end
+    end
+
+    # Invalid argument passed to Momento client
+    class InvalidArgumentError < ArgumentError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :INVALID_ARGUMENT_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "Invalid argument passed to Momento client: #{details}"
+      end
+    end
+
+    # Request rate exceeded the limits for this account.
+    class LimitExceededError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :LIMIT_EXCEEDED_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "Request rate exceeded the limits for this account.  To resolve this error, reduce your request rate, or contact Momento to request a limit increase."
+      end
+    end
+
+    # A cache with the specified name does not exist.
+    class NotFoundError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :NOT_FOUND_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "A cache with the specified name does not exist.  To resolve this error, make sure you have created the cache before attempting to use it.  Cache name: '#{context[:cache_name]}'"
+      end
+    end
+
+    # Insufficient permissions to perform an operation on a cache.
+    class PermissionError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :PERMISSION_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "Insufficient permissions to perform an operation on a cache: #{details}"
+      end
+    end
+
+    # The server was unable to handle the request
+    class ServerUnavailableError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :SERVER_UNAVAILABLE
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "The server was unable to handle the request; consider retrying.  If the error persists, please contact Momento."
+      end
+    end
+
+    # The client's configured timeout was exceeded.
+    class TimeoutError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :TIMEOUT_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "The client's configured timeout was exceeded; you may need to use a Configuration with more lenient timeouts.  Timeout value: #{context[:timeout]}"
+      end
+    end
+
+    # The cache service failed due to an internal error
+    class UnknownError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :UNKNOWN_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "CacheService failed due to an internal error"
+      end
+    end
+
+    # The cache service failed due to an internal error
+    class UnknownServiceError < RuntimeError
+      include Momento::Error
+
+      # (see Momento::Error#error_code)
+      def error_code
+        :UNKNOWN_SERVICE_ERROR
+      end
+
+      # (see Momento::Error#message)
+      def message
+        "The service returned an unknown response; please contact Momento: #{details}"
+      end
+    end
+
+    # rubocop:enable Layout/LineLength
+  end
+end

data/lib/momento/error.rb

@@ -0,0 +1,54 @@
+require_relative 'error/types'
+
+module Momento
+  # Errors from the Momento client or service, available as `response.error`.
+  #
+  # Momento::Errors are Exceptions. They can be raised. If the error was
+  # caused by an exception, it will be available in {#cause}.
+  #
+  # @example
+  #   # This is a contrived example to show what you can do with a Momento::Error.
+  #   response = client.cache_name(cache_name, key)
+  #   if response.error?
+  #     error = response.error
+  #
+  #     puts "Creating the cache failed: #{error}"
+  #     puts "The cause was #{error.cause}"
+  #     puts "The details of the error are #{error.details}"
+  #     puts "The error code is #{error.error_code}"
+  #
+  #     case error
+  #     when Momento::Error::LimitExceededError
+  #       puts "We'll have to slow down"
+  #     when Momento::Error::PermissionError
+  #       puts "We'll have to fix our auth token"
+  #     when Momento::Error::InvalidArgumentError
+  #       puts "We can't make a cache named #{cache_name}"
+  #     end
+  #
+  #     raise error
+  #   end
+  module Error
+    # @return [Exception] the original exception which was the cause of the error
+    attr_accessor :cause
+    # @return [Hash] any context relevant to the error such as method arguments
+    attr_accessor :context
+    # @return [Momento::Error::TransportDetails] details about the transport layer
+    attr_accessor :transport_details
+    # @return [String] details about the error
+    attr_accessor :details
+
+    # @!method error_code
+    #   A Momento-specific code for the type of error.
+    #   @return [Symbol]
+
+    # @!method message
+    #   The error message.
+    #   @return [String]
+
+    # (see #message)
+    def to_s
+      message
+    end
+  end
+end

data/lib/momento/error_builder.rb

@@ -0,0 +1,50 @@
+require 'grpc'
+require_relative 'error/types'
+require_relative 'exceptions'
+
+module Momento
+  # @private
+  class ErrorBuilder
+    EXCEPTION_MAP = {
+      GRPC::Aborted => Error::InternalServerError,
+      GRPC::AlreadyExists => Error::AlreadyExistsError,
+      GRPC::Cancelled => Error::CancelledError,
+      GRPC::DataLoss => Error::InternalServerError,
+      GRPC::DeadlineExceeded => Error::TimeoutError,
+      GRPC::FailedPrecondition => Error::FailedPreconditionError,
+      GRPC::Internal => Error::InternalServerError,
+      GRPC::InvalidArgument => Error::InvalidArgumentError,
+      GRPC::NotFound => Error::NotFoundError,
+      GRPC::OutOfRange => Error::BadRequestError,
+      GRPC::PermissionDenied => Error::PermissionError,
+      GRPC::ResourceExhausted => Error::LimitExceededError,
+      GRPC::Unauthenticated => Error::AuthenticationError,
+      GRPC::Unavailable => Error::ServerUnavailableError,
+      GRPC::Unimplemented => Error::BadRequestError,
+      GRPC::Unknown => Error::UnknownServiceError,
+      Momento::CacheNameError => Error::InvalidArgumentError
+    }.freeze
+
+    class << self
+      def from_exception(exception, context: {})
+        error_class = EXCEPTION_MAP[exception.class] || Error::UnknownError
+
+        error = error_class.new
+        error.context = context
+        error.cause = exception
+
+        case exception
+        when GRPC::BadStatus
+          error.transport_details = Error::TransportDetails.new(grpc: exception)
+          error.details = exception.details
+        else
+          error.details = exception.message
+        end
+
+        error.freeze
+
+        return error
+      end
+    end
+  end
+end

data/lib/momento/exceptions.rb

@@ -0,0 +1,7 @@
+module Momento
+  # Used to indicate an error in the cache name to be rescued
+  # and turned into an InvalidArgument respponse.
+  # @private
+  class CacheNameError < ::ArgumentError
+  end
+end

data/lib/momento/generated/README.md

@@ -0,0 +1,16 @@
+# Generate proto code
+
+1. Change into this directory, specify the path to the protos directory in the bash script, then run it:
+
+```
+cd path/to/client-sdk-ruby/lib/momento/generated/
+export PROTO_PATH="path/to/client-protos/proto/"
+./generate_protos.sh
+```
+
+2. Verify unit tests still pass by going back to the top-level directory and running `rspec`:
+
+```
+cd ../../..
+rspec
+```

data/lib/momento/generated/auth_pb.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: auth.proto
+
+require 'google/protobuf'
+
+require_relative 'permissionmessages_pb'
+
+descriptor_data = "\n\nauth.proto\x12\x04\x61uth\x1a\x18permissionmessages.proto\"\x0f\n\r_LoginRequest\"\xfc\x02\n\x0e_LoginResponse\x12<\n\x0e\x64irect_browser\x18\x01 \x01(\x0b\x32\".auth._LoginResponse.DirectBrowserH\x00\x12\x32\n\tlogged_in\x18\x02 \x01(\x0b\x32\x1d.auth._LoginResponse.LoggedInH\x00\x12/\n\x07message\x18\x03 \x01(\x0b\x32\x1c.auth._LoginResponse.MessageH\x00\x12+\n\x05\x65rror\x18\x04 \x01(\x0b\x32\x1a.auth._LoginResponse.ErrorH\x00\x1a<\n\x08LoggedIn\x12\x15\n\rsession_token\x18\x01 \x01(\t\x12\x19\n\x11valid_for_seconds\x18\x02 \x01(\r\x1a\x1c\n\x05\x45rror\x12\x13\n\x0b\x64\x65scription\x18\x01 \x01(\t\x1a\x1c\n\rDirectBrowser\x12\x0b\n\x03url\x18\x01 \x01(\t\x1a\x17\n\x07Message\x12\x0c\n\x04text\x18\x01 \x01(\tB\x07\n\x05state\"\xb7\x02\n\x18_GenerateApiTokenRequest\x12\x35\n\x05never\x18\x01 \x01(\x0b\x32$.auth._GenerateApiTokenRequest.NeverH\x00\x12\x39\n\x07\x65xpires\x18\x02 \x01(\x0b\x32&.auth._GenerateApiTokenRequest.ExpiresH\x00\x12\x12\n\nauth_token\x18\x03 \x01(\t\x12\x35\n\x0bpermissions\x18\x04 \x01(\x0b\x32 .permission_messages.Permissions\x12\x10\n\x08token_id\x18\x05 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x06 \x01(\t\x1a\x07\n\x05Never\x1a$\n\x07\x45xpires\x12\x19\n\x11valid_for_seconds\x18\x01 \x01(\rB\x08\n\x06\x65xpiry\"j\n\x19_GenerateApiTokenResponse\x12\x0f\n\x07\x61pi_key\x18\x01 \x01(\t\x12\x15\n\rrefresh_token\x18\x02 \x01(\t\x12\x10\n\x08\x65ndpoint\x18\x03 \x01(\t\x12\x13\n\x0bvalid_until\x18\x04 \x01(\x04\"A\n\x17_RefreshApiTokenRequest\x12\x0f\n\x07\x61pi_key\x18\x01 \x01(\t\x12\x15\n\rrefresh_token\x18\x02 \x01(\t\"i\n\x18_RefreshApiTokenResponse\x12\x0f\n\x07\x61pi_key\x18\x01 \x01(\t\x12\x15\n\rrefresh_token\x18\x02 \x01(\t\x12\x10\n\x08\x65ndpoint\x18\x03 \x01(\t\x12\x13\n\x0bvalid_until\x18\x04 \x01(\x04\x32\xe9\x01\n\x04\x41uth\x12\x36\n\x05Login\x12\x13.auth._LoginRequest\x1a\x14.auth._LoginResponse\"\x00\x30\x01\x12U\n\x10GenerateApiToken\x12\x1e.auth._GenerateApiTokenRequest\x1a\x1f.auth._GenerateApiTokenResponse\"\x00\x12R\n\x0fRefreshApiToken\x12\x1d.auth._RefreshApiTokenRequest\x1a\x1e.auth._RefreshApiTokenResponse\"\x00\x42\x42\n\x0cmomento.authP\x01Z0github.com/momentohq/client-sdk-go;client_sdk_gob\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require_relative 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["permission_messages.Permissions", "permissionmessages.proto"]
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module MomentoProtos
+  module Auth
+    PB__LoginRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginRequest").msgclass
+    PB__LoginResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginResponse").msgclass
+    PB__LoginResponse::LoggedIn = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginResponse.LoggedIn").msgclass
+    PB__LoginResponse::Error = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginResponse.Error").msgclass
+    PB__LoginResponse::DirectBrowser = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginResponse.DirectBrowser").msgclass
+    PB__LoginResponse::Message = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._LoginResponse.Message").msgclass
+    PB__GenerateApiTokenRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._GenerateApiTokenRequest").msgclass
+    PB__GenerateApiTokenRequest::Never = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._GenerateApiTokenRequest.Never").msgclass
+    PB__GenerateApiTokenRequest::Expires = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._GenerateApiTokenRequest.Expires").msgclass
+    PB__GenerateApiTokenResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._GenerateApiTokenResponse").msgclass
+    PB__RefreshApiTokenRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._RefreshApiTokenRequest").msgclass
+    PB__RefreshApiTokenResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("auth._RefreshApiTokenResponse").msgclass
+  end
+end

data/lib/momento/generated/auth_services_pb.rb

@@ -0,0 +1,27 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: auth.proto for package 'auth'
+
+require 'grpc'
+require_relative 'auth_pb'
+
+module MomentoProtos
+  module Auth
+    module Auth
+      class Service
+        include ::GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'auth.Auth'
+
+        rpc :Login, ::Auth::PB__LoginRequest, stream(::Auth::PB__LoginResponse)
+        # api for initially generating api and refresh tokens
+        rpc :GenerateApiToken, ::Auth::PB__GenerateApiTokenRequest, ::Auth::PB__GenerateApiTokenResponse
+        # api for programmatically refreshing api and refresh tokens
+        rpc :RefreshApiToken, ::Auth::PB__RefreshApiTokenRequest, ::Auth::PB__RefreshApiTokenResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end