volcano-sdk 0.5.2 → 0.5.3

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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +22 -4
  3. data/lib/volcano/version.rb +1 -1
  4. metadata +15 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 661418937049846fdcdec6332b897bc1b88e7359ed0b70f71e29cdd342302302
4
- data.tar.gz: 6284d21cb08cdf77ea42829fe3fcefd48b3f741b9c49ad71665249a63c941e17
3
+ metadata.gz: 939a91c580dbb07f0cc04f6930c2ea4be62ca7ab7f0106e93b8862d0a310d7b5
4
+ data.tar.gz: f577bff2cca54ae9fbb5b2375cc45c1671f17fe8372b5f087273251929488ce8
5
5
  SHA512:
6
- metadata.gz: 6acc1b7db432a0e7a33bffe77a8a7463e0c9b063049f0807327bcafd9e1e7f44bd2f5a973bb905705598254a2c51b5cc86abd403a357516eda3659c0a885fb6c
7
- data.tar.gz: f582e4a361354e3e41a1988a423260638770543dc1c268dbb99f37d42ee7b13e2a373ae4872af7fa994a729cc33e8aaad9a1cfd3ecde8aa6b2cdf57f1f3569e9
6
+ metadata.gz: 5df58a522d1c82cea769ff810620b9837247781a8e13c25add391d9287fd1bee253ddd672508606f2c59eb93988790d5c68cda418b66a90cb8527a8afb5bac97
7
+ data.tar.gz: c742eaa7aec57e3f151cb650a10fe1fc10641f862196158c259b6cc9c5cad439df908a4603b4c7d7818b1bcdd5aa0ebbca685cd0c75c78188958a2176921955f
data/README.md CHANGED
@@ -1,9 +1,23 @@
1
1
  # Volcano Ruby SDK
2
2
 
3
- Official Ruby SDK for Volcano. This repository is a private proof of concept;
4
- the gem is not published yet.
3
+ Official Ruby SDK for Volcano. Requires Ruby 3.2 or later.
5
4
 
6
- ## Proof-of-concept API
5
+ ## Install
6
+
7
+ Add the gem to your Gemfile and run `bundle install`:
8
+
9
+ ```ruby
10
+ gem "volcano-sdk"
11
+ ```
12
+
13
+ Require it with `require "volcano"`. New versions publish to RubyGems
14
+ automatically after a Release Please release PR merges and the release checks
15
+ pass.
16
+
17
+ Maintainers: see [Publishing releases](https://github.com/Kong/volcano-sdk-ruby/blob/main/PUBLISHING.md) for trusted publisher setup
18
+ and the release procedure.
19
+
20
+ ## Create a client
7
21
 
8
22
  Create a client with the project URL and anonymous key from Volcano:
9
23
 
@@ -414,7 +428,11 @@ result = client.functions.invoke(
414
428
  puts [result.status, result.version, result.data]
415
429
  ```
416
430
 
417
- `invoke` resolves a DNS-safe function name and sends a JSON object. It uses the
431
+ `invoke` resolves a DNS-safe function name and sends a JSON object. The request
432
+ goes to the function's own domain rather than to `api_url`, so an egress rule
433
+ that allows only the API host will block it; the resolved endpoint is cached for
434
+ the lifetime the platform gives it. Deployments with no public function domain
435
+ invoke through the API host instead. It uses the
418
436
  active user session when present, then a configured service key, then the
419
437
  anonymous key. An anonymous key can invoke a public function without a user
420
438
  session; the function receives no user identity. The immutable result includes
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Volcano
4
- VERSION = '0.5.2'
4
+ VERSION = '0.5.3'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: volcano-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.2
4
+ version: 0.5.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kong
@@ -51,6 +51,20 @@ dependencies:
51
51
  - - '='
52
52
  - !ruby/object:Gem::Version
53
53
  version: 0.30.0
54
+ - !ruby/object:Gem::Dependency
55
+ name: base64
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '0.2'
61
+ type: :runtime
62
+ prerelease: false
63
+ version_requirements: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '0.2'
54
68
  - !ruby/object:Gem::Dependency
55
69
  name: logger
56
70
  requirement: !ruby/object:Gem::Requirement