Class: Bollard

Inherits:

Object

• Object
• Bollard

Defined in:

lib/bollard.rb,
lib/bollard/token.rb,
lib/bollard/version.rb,
lib/bollard/signature.rb

Defined Under Namespace

Classes: Signature, Token

Constant Summary

SignatureVerificationError =

Class.new(RuntimeError)

VERSION =

"2.0.0"

Class Method Summary

• .generate_secret(length: 32) ⇒ Object

Instance Method Summary

• #generate_token(payload, **args) ⇒ Object
• #initialize(signing_secret) ⇒ Bollard constructor

  A new instance of Bollard.

• #verify_payload(payload, token, **args) ⇒ Object

Constructor Details

#initialize(signing_secret) ⇒ Bollard

Returns a new instance of Bollard.

# File 'lib/bollard.rb', line 13

def initialize(signing_secret)
  @signing_secret = signing_secret
end

Class Method Details

.generate_secret(length: 32) ⇒ Object

# File 'lib/bollard.rb', line 8

def self.generate_secret(length: 32)
  SecureRandom.hex((length / 2.0).ceil)[0...length]
end

Instance Method Details

#generate_token(payload, **args) ⇒ Object

# File 'lib/bollard.rb', line 18

def generate_token(payload, **args)
  Token.generate(payload, signing_secret, **args)
end

#verify_payload(payload, token, **args) ⇒ Object

# File 'lib/bollard.rb', line 23

def verify_payload(payload, token, **args)
  Token.new(token, signing_secret).verify_payload(payload, **args)
end