Class: Pubnub::Crypto::CryptoProvider

Inherits:

Object

• Object
• Pubnub::Crypto::CryptoProvider

Defined in:

lib/pubnub/modules/crypto/crypto_provider.rb

Overview

Base class which is used to implement a module that can be used to configure PubNub client or for manual data encryption and decryption.

Direct Known Subclasses

CryptoModule

Instance Method Summary

• #decrypt(data) ⇒ String^?

  Decrypt provided data.

• #encrypt(data) ⇒ String^?

  Encrypt provided data.

Instance Method Details

#decrypt(data) ⇒ String^?

Decrypt provided data.

Parameters:

• data (String) —

  Encrypted data for decryption.

Returns:

• (String, nil) —

  Decrypted data or nil in case of decryption error.

Raises:

• (UnknownCryptorError) —

  If the cryptor for data processing is not registered.

# File 'lib/pubnub/modules/crypto/crypto_provider.rb', line 26

def decrypt(data)
  raise NotImplementedError, 'Subclass should provide "decrypt" method implementation.'
end

#encrypt(data) ⇒ String^?

Encrypt provided data.

Parameters:

• data (String) —

  Source data for encryption.

Returns:

• (String, nil) —

  Encrypted data or nil in case of encryption error.

Raises:

• (NotImplementedError)

# File 'lib/pubnub/modules/crypto/crypto_provider.rb', line 14

def encrypt(data)
  raise NotImplementedError, 'Subclass should provide "encrypt" method implementation.'
end