Class: CryptoconditionsRuby::Fulfillment

Inherits:
Object
  • Object
show all
Extended by:
Crypto::Helpers
Includes:
Crypto::Helpers
Defined in:
lib/cryptoconditions_ruby/fulfillment.rb

Constant Summary collapse

TYPE_ID = 
nil
REGEX = 
FULFILLMENT_REGEX
FEATURE_BITMASK = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Crypto::Helpers

base64_add_padding, base64_remove_padding, ed25519_generate_key_pair

Class Method Details

.from_binary(reader) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 40

def self.from_binary(reader)
  reader = Utils::Reader.from_source(reader)

  cls_type = reader.read_uint16
  cls = TypeRegistry.get_class_from_type_id(cls_type)

  fulfillment = cls.new
  payload_length = reader.read_length_prefix
  fulfillment.parse_payload(reader, payload_length)
  fulfillment
end

.from_dict(data) ⇒ Object 



52
53
54
55
56
57
58
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 52

def self.from_dict(data)
  cls_type = data['type_id']
  cls = TypeRegistry.get_class_from_type_id(cls_type)
  fulfillment = cls.new
  fulfillment.parse_dict(data)
  fulfillment
end

.from_uri(serialized_fulfillment) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 13

def self.from_uri(serialized_fulfillment)
  return serialized_fulfillment if serialized_fulfillment.is_a?(Fulfillment)

  unless serialized_fulfillment.is_a?(String)
    raise TypeError, 'Serialized fulfillment must be a string'
  end

  pieces = serialized_fulfillment.split(':', -1)

  unless pieces.first == 'cf'
    raise TypeError, 'Serialized fulfillment must start with "cf:"'
  end

  unless serialized_fulfillment.match(Fulfillment::REGEX)
    raise TypeError, 'Invalid fulfillment format'
  end

  type_id = pieces[1].to_i(16)
  payload = Base64.urlsafe_decode64(base64_add_padding(pieces[2]))

  cls = TypeRegistry.get_class_from_type_id(type_id)
  fulfillment = cls.new

  fulfillment.parse_payload(Utils::Reader.from_source(payload), payload.length)
  fulfillment
end

Instance Method Details

#bitmask ⇒ Object 



64
65
66
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 64

def bitmask
  self.class::FEATURE_BITMASK
end

#calculate_max_fulfillment_length ⇒ Object 



89
90
91
92
93
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 89

def calculate_max_fulfillment_length
  predictor = Utils::Predictor.new
  write_payload(predictor)
  predictor.size
end

#condition ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 68

def condition
  condition = Condition.new
  condition.type_id = type_id
  condition.bitmask = bitmask
  condition.hash = generate_hash
  condition.max_fulfillment_length = calculate_max_fulfillment_length
  condition
end

#condition_binary ⇒ Object 



81
82
83
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 81

def condition_binary
  condition.serialize_binary
end

#condition_uri ⇒ Object 



77
78
79
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 77

def condition_uri
  condition.serialize_uri
end

#generate_hash ⇒ Object 



85
86
87
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 85

def generate_hash
  raise 'Implement me'
end

#parse_dict(_data) ⇒ Object 



130
131
132
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 130

def parse_dict(_data)
  raise 'Implement me'
end

#parse_payload(_reader, *_args) ⇒ Object 



122
123
124
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 122

def parse_payload(_reader, *_args)
  raise 'Implement me'
end

#serialize_binary ⇒ Object 



105
106
107
108
109
110
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 105

def serialize_binary
  writer = Utils::Writer.new
  writer.write_uint16(type_id)
  writer.write_var_octet_string(serialize_payload)
  writer.buffer
end

#serialize_payload ⇒ Object 



112
113
114
115
116
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 112

def serialize_payload
  writer = Utils::Writer.new
  write_payload(writer)
  writer.buffer
end

#serialize_uri ⇒ Object 



95
96
97
98
99
100
101
102
103
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 95

def serialize_uri
  format(
    'cf:%x:%s',
    type_id,
    base64_remove_padding(
      Base64.urlsafe_encode64(serialize_payload)
    )
  )
end

#to_dict ⇒ Object 



126
127
128
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 126

def to_dict
  raise 'Implement me'
end

#type_id ⇒ Object 



60
61
62
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 60

def type_id
  self.class::TYPE_ID
end

#validate(**_kwargs) ⇒ Object 



134
135
136
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 134

def validate(**_kwargs)
  raise 'Implement me'
end

#write_payload(_writer) ⇒ Object 



118
119
120
 
# File 'lib/cryptoconditions_ruby/fulfillment.rb', line 118

def write_payload(_writer)
  raise 'Implement me'
end