human-attestation 0.4.1 → 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d6db10c461f3561ad7514a96c9da975eae5cdcb71928b31cb8019091a0fc7b63
4
- data.tar.gz: 7e4c6628871c67bff9adfa774680a3cd7838e3c3053603393787d572af216837
3
+ metadata.gz: a5d1c1a78d723f2a99430958304aaed1ccc58517b9963a71d545ddddaee4513d
4
+ data.tar.gz: 5a107747f77df90756a038ed53ac7ffcecb37695ec1e85c5dcfc6c7665a52a89
5
5
  SHA512:
6
- metadata.gz: c595e143adff3cc2fe84e8154e6eabc1deaa46e3e294b1381f8d0b62f2d98c58ea95955666482deca38a58d5433ce977c30e3a7b6c8d25b8a87693c9977f7bfe
7
- data.tar.gz: 76d0ef14f114aa9a5e945ad62e76313169ded28aff69d105afbeb36ae34331fbd2baac83f58ee3fb7911c5ef13aeaee7769824a6d90c28f0a0b6c1c482ebf9d4
6
+ metadata.gz: adbae196ca5158dde90a4bcc1611b04e8e5b1ff0b9b406b8da4c75353aeaa15af180b0e6c1736e3df3305b357e5fc20d80f84c36f0e7269b56e2671ee08c11a0
7
+ data.tar.gz: 7e61fc2db994120ead56ede2d8a450061de0b1baed403f06f5a5b56bd5ba98183dfd460a04a597fbd06527b97da6799e4371b4abd8affa40f9472f8c6b395d03
data/README.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # human-attestation
2
2
 
3
+ [![Gem Version](https://img.shields.io/gem/v/human-attestation.svg)](https://rubygems.org/gems/human-attestation)
4
+ [![CI](https://github.com/Blue-Scroll/hap/actions/workflows/ci.yml/badge.svg)](https://github.com/Blue-Scroll/hap/actions/workflows/ci.yml)
5
+ [![Ruby](https://img.shields.io/badge/ruby-3.0+-blue.svg)](https://www.ruby-lang.org/)
6
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](../../LICENSE)
7
+
3
8
  Official HAP (Human Attestation Protocol) SDK for Ruby.
4
9
 
5
10
  HAP is an open standard for verified human effort. It enables Verification Authorities (VAs) to cryptographically attest that a sender took deliberate, costly action when communicating with a recipient.
@@ -132,6 +137,35 @@ puts "Signed JWS: #{jws}"
132
137
  | `HumanAttestation.generate_id` | Generate cryptographically secure HAP ID |
133
138
  | `HumanAttestation.create_claim(...)` | Create claim with defaults |
134
139
 
140
+ ### Types
141
+
142
+ The SDK uses Ruby hashes with symbol keys. Key structures:
143
+
144
+ ```ruby
145
+ # Claim structure
146
+ {
147
+ v: "0.1",
148
+ id: "hap_...",
149
+ method: "physical_mail",
150
+ description: "...",
151
+ to: { name: "Company", domain: "company.com" },
152
+ at: "2026-01-19T06:00:00Z",
153
+ exp: "2028-01-19T06:00:00Z", # optional
154
+ iss: "ballista.jobs",
155
+ cost: { amount: 1500, currency: "USD" }, # optional
156
+ time: 1800, # optional
157
+ physical: true # optional
158
+ }
159
+
160
+ # JWK structure (OKP = Octet Key Pair, the format for Ed25519 keys)
161
+ {
162
+ kid: "my_key_001",
163
+ kty: "OKP",
164
+ crv: "Ed25519",
165
+ x: "<base64url-public-key>"
166
+ }
167
+ ```
168
+
135
169
  ## Requirements
136
170
 
137
171
  - Ruby 3.0+
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module HumanAttestation
4
- VERSION = "0.4.1"
4
+ VERSION = "0.4.4"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: human-attestation
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.1
4
+ version: 0.4.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - BlueScroll Inc.
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-01-22 00:00:00.000000000 Z
11
+ date: 2026-01-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: ed25519