Class: Universa::HashId

Inherits:
RemoteAdapter show all
Defined in:
lib/universa/contract.rb

Overview

Adapter for Universa HashId class, helps to avoid confusion when using different representations of the ID.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RemoteAdapter

#__getobj__, #__setobj__, #initialize, #inspect, invoke_static, remote_class, remote_class_name, remote_field, static_method

Constructor Details

This class inherits a constructor from Universa::RemoteAdapter

Class Method Details

.create_random ⇒ HashId

Create a random HashId

Returns:



171
172
173
 
# File 'lib/universa/contract.rb', line 171

def self.create_random
  invoke_static 'create_random'
end

.from_digest(digest_bytes) ⇒ HashId

Construct from binary representation, not to confuse with binary one.

Parameters:

  • digest_bytes (String) —

    binary string of some hash_id.bytes

Returns:

  • (HashId) —

    instance with instance.bytes == digest.bytes



155
156
157
158
 
# File 'lib/universa/contract.rb', line 155

def self.from_digest(digest_bytes)
  digest_bytes.force_encoding 'binary'
  invoke_static 'with_digest', digest_bytes
end

.from_string(string_id) ⇒ Object

Construct from string representation of the ID, not to confuse with binary one. This method takes both regular base64 representation and RFC3548 url-safe modification, as from #to_url_safe_string.

Parameters:

  • string_id (String) —

    id string representation, like from hash_id_instance.to_s. See #to_s.



164
165
166
167
 
# File 'lib/universa/contract.rb', line 164

def self.from_string(string_id)
  string_id.force_encoding('utf-8').gsub('-', '+').gsub('_', '/')
  invoke_static 'with_digest', string_id
end

Instance Method Details

#==(other) ⇒ Object

Compare hashid with string representation, binary representation or another HashId instance automatically.



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/universa/contract.rb', line 216

def == other
  return false if other == nil
  if other.is_a?(Universa::HashId)
    super
  else
    if other.size == 96
      bytes == other
    else
      to_s == other
    end
  end
end

#bytes ⇒ String

Get binary representation. It is shorter than string representation but contain non-printable characters and can cause problems if treated like a string. Use #to_s to get string representation instead.

Returns:

  • (String) —

    binary string



180
181
182
 
# File 'lib/universa/contract.rb', line 180

def bytes
  @bytes ||= get_digest
end

#eql?(other) ⇒ Boolean

To use it as a hash key_address. Same as this == other.

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/universa/contract.rb', line 210

def eql? other
  self == other
end

#hash ⇒ Object

To use it as a hash key_address.

Returns:

  • hash calculated over the digest bytes



205
206
207
 
# File 'lib/universa/contract.rb', line 205

def hash
  bytes.hash
end

#to_s ⇒ String

Get string representation. It is, actually, base64 encoded string representation. Longer, but could easily be transferred with text protocols.

Returns:

  • (String) —

    string representation



189
190
191
 
# File 'lib/universa/contract.rb', line 189

def to_s
  @str ||= Base64.encode64(get_digest).gsub(/\s/, '')
end

#to_url_safe_string ⇒ String

Converts to URL-safe varianot of base64, as RFC 3548 suggests:

the 63:nd / character with the underscore _
the 62:nd + character with the minus -

Could be decoded safely back with from_string but not (most likely) with JAVA API itself

Returns:

  • (String) —

    RFC3548 modified base64



199
200
201
 
# File 'lib/universa/contract.rb', line 199

def to_url_safe_string
  @urlsafe_str ||= Base64.encode64(get_digest).gsub(/\s/, '').gsub('/', '_').gsub('+', '-')
end