Module: SimpleOAuth::Encoding

Included in:
Header
Defined in:
lib/simple_oauth/encoding.rb,
sig/simple_oauth.rbs

Overview

OAuth percent-encoding utilities

Constant Summary collapse

UNRESERVED_CHARS =

Characters that don't need to be escaped per OAuth spec

Returns:

  • (Regexp) 
/[^a-z0-9\-._~]/i

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.decode ⇒ String

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


36
 
# File 'sig/simple_oauth.rbs', line 36

def self.decode: (String | _ToS value) -> String

.encode ⇒ String

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


34
 
# File 'sig/simple_oauth.rbs', line 34

def self.encode: (String | _ToS value) -> String

.escape ⇒ String

Module-level methods (via extend self)

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


33
 
# File 'sig/simple_oauth.rbs', line 33

def self.escape: (String | _ToS value) -> String

.unescape ⇒ String

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


35
 
# File 'sig/simple_oauth.rbs', line 35

def self.unescape: (String | _ToS value) -> String

Instance Method Details

#escape(value) ⇒ String Also known as: encode

Percent-encodes a value according to OAuth specification

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


32
33
34
 
# File 'lib/simple_oauth/encoding.rb', line 32

def escape(value)
  URI::RFC2396_PARSER.escape(value.to_s, UNRESERVED_CHARS)
end

#unescape(value) ⇒ String Also known as: decode

Decodes a percent-encoded value

Parameters:

  • value (String, _ToS)

Returns:

  • (String) 


45
46
47
 
# File 'lib/simple_oauth/encoding.rb', line 45

def unescape(value)
  URI::RFC2396_PARSER.unescape(value.to_s)
end