vallkey 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 074654bc2f673408657502e765d210f70111952010045420dc5ebc9e9145e8f6
-  data.tar.gz: 8afe3aa50b9cfb716e50479bd512f8434350469c4fb31a535b4bf71e9d05115a
+  metadata.gz: 58237aacff3a14626297ec257d52fc8e403ef687a3b982314650dee3d5fca384
+  data.tar.gz: bc697f3b2153a60f54e97de40032aa4e4115bf7c87e206cc09c67b6f972212da
 SHA512:
-  metadata.gz: a26f6c8a1f422ff6dd939c9019b44f6f35d85711edfb386a2750031335b62d9ecd4c1f24978a688843faea2dcbac7bbd290f5355256cdb0de56ae49f6b8732c9
-  data.tar.gz: 45ef6f57c399b065d32faa0699520a55bc22f5dbc6c7c64d3f5ed94dbe2e69896030700649fc86c9e1b1ac91cc3a4cfa6d7156476de436b8806e88926caaec6f
+  metadata.gz: a9472118b607a55f00afecfb68197fa0ef7e3b60085067d9d30713bcb5f777527e61f520de0fc42c0ee33ef3e4c45b560a11eb0cf04fa1182680bd91612e58c9
+  data.tar.gz: c0123dfbe198a67423622690bd7589e8723f33f59cf5a5cfd43e76e11353e3bd45a31f8bfd2bef860ca01ad88e5f6d4c5135d815bf9d1158565f9c22f81b8a3d

data/README.md

@@ -1,6 +1,8 @@
+![Vallkey ruby](https://raw.githubusercontent.com/vallkeyhq/developer-tools/main/assets/covers/ruby.png)
+
 # vallkey (Ruby)
 
-Send any Ruby SDK through [Vallkey](https://vallkey.com) with no code changes. Requests that carry a ghost key go to Vallkey, which swaps in the real key under your rules. Every other request is left alone.
+Route ghost-key requests through [Vallkey](https://vallkey.com) using the supported HTTP clients below. Requests that carry a ghost key go to Vallkey, which swaps in the real key under your rules. Every other request is left alone.
 
 ```sh
 gem install vallkey
@@ -9,10 +11,14 @@ RUBYOPT=-rvallkey/auto bundle exec rails server
 
 Using `bundle exec`? Add `gem "vallkey"` to your Gemfile too: Bundler only loads the gems it lists.
 
-Covers Net::HTTP, which carries almost every Ruby SDK (Stripe, OpenAI, Anthropic, AWS, and Twilio, Octokit and Slack through Faraday).
+Covers Net::HTTP, used by SDKs configured for this transport (Stripe, OpenAI, Anthropic, AWS, and Twilio, Octokit and Slack through Faraday).
+
+| Setting           | What it does                                           |
+| ----------------- | ------------------------------------------------------ |
+| `VALLKEY_API`     | The Vallkey server (default `https://api.vallkey.com`) |
+| `VALLKEY_AUTO=0`  | Turns it off                                           |
+| `VALLKEY_DEBUG=1` | Logs each request sent to Vallkey (never the key)      |
+
+## Compatibility and security
 
-| Setting | What it does |
-|---|---|
-| `VALLKEY_API` | The Vallkey server (default `https://api.vallkey.com`) |
-| `VALLKEY_AUTO=0` | Turns it off |
-| `VALLKEY_DEBUG=1` | Logs each request sent to Vallkey (never the key) |
+Read the [transport boundaries](https://github.com/vallkeyhq/developer-tools/blob/main/docs/compatibility.md) and [security policy](../SECURITY.md). Local transport tests do not certify every SDK version or cloud deployment. Use a dedicated key and verify requests from the actual application after deployment.

data/lib/vallkey/patch.rb

@@ -1,19 +1,6 @@
-# Sends every request that carries a ghost key to Vallkey instead of the provider, with
-# the same path, so any SDK works without setting a base URL. Requests without a ghost
-# key are not touched.
-#
-# Covers Net::HTTP, which carries almost every Ruby SDK: on its own (Stripe, OpenAI,
-# Anthropic, AWS), and under Faraday, HTTParty and rest-client (Twilio, Octokit, Slack).
-# Net::HTTP is patched once the app loads it, never loaded from here: under Bundler,
-# loading it before the app could pick another version than the app's Gemfile.lock.
-#
-# Each request sent to Vallkey says in x-vallkey-host which address it was for, and in
-# x-vallkey-hook what sent it: this hook, Ruby's version, the platform and VALLKEY_ENV, so
-# the dashboard can show each place a key is used. Never app names or secrets.
-#
-# VALLKEY_API      the Vallkey server (default https://api.vallkey.com)
-# VALLKEY_DEBUG=1  logs each request sent to Vallkey (never the key)
-# VALLKEY_ENV      a name for this place (production, staging...), shown in the dashboard
+# Redirect recognized ghost credentials in Net::HTTP requests.
+# Install after Net::HTTP loads so Bundler retains control of its version.
+# See README.md for configuration and transport boundaries.
 module Vallkey
   module Patch
     GHOST = /gk_[a-z]{2,20}_[A-Za-z0-9_-]{22}_[A-Za-z0-9_-]{43}/.freeze
@@ -150,6 +137,7 @@ module Vallkey
       def request(req, body = nil, &block)
         moved = Vallkey::Patch.installed && Vallkey::Patch.redirect?(self, req, body)
         unless moved
+          Vallkey::Patch.tag(self, req, body) if Vallkey::Patch.installed
           if @vallkey_deferred
             @vallkey_deferred = false
             connect
@@ -182,6 +170,7 @@ module Vallkey
 
     class << self
       def redirect?(http, req, body)
+        return false if ENV["VALLKEY_AUTO"] == "0" # a .env file loaded after start can turn it off
         t = target
         return false if http.address == t.host && http.port == t.port
         headers = []
@@ -190,11 +179,25 @@ module Vallkey
         scheme = http.use_ssl? ? "https" : "http"
         default = http.use_ssl? ? 443 : 80
         from = http.port == default ? http.address : "#{http.address}:#{http.port}"
-        log("#{scheme}://#{from}#{req.path.to_s.split('?', 2)[0]}", "#{t.scheme}://#{t.host_with_port}")
+        log("#{scheme}://#{from}", "#{t.scheme}://#{t.host_with_port}")
         [t, from]
       rescue StandardError
         false # anything unusual goes out as it was
       end
+
+      # Already addressed to Vallkey by an SDK's address setting: say which app it is, so
+      # one app is one place on the dashboard however each SDK reaches Vallkey.
+      def tag(http, req, body)
+        return if ENV["VALLKEY_AUTO"] == "0"
+        t = target
+        return unless http.address == t.host && http.port == t.port
+        return if req[WHO_HEADER]
+        headers = []
+        req.each_header { |name, value| headers << [name, value] }
+        req[WHO_HEADER] = who if ghost?(req.path, headers, body || req.body)
+      rescue StandardError
+        nil # anything unusual goes out as it was
+      end
     end
   end
 end

data/lib/vallkey/version.rb

@@ -1,3 +1,3 @@
 module Vallkey
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vallkey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vallkey
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-27 00:00:00.000000000 Z
 dependencies: []
 description: Requests that carry a Vallkey ghost key go to Vallkey; nothing else is
   touched. Turn it on with RUBYOPT=-rvallkey/auto.
@@ -26,6 +26,8 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://vallkey.com/docs/
+  source_code_uri: https://github.com/vallkeyhq/developer-tools/tree/main/ruby
+  bug_tracker_uri: https://github.com/vallkeyhq/developer-tools/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -41,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Send any Ruby SDK through Vallkey with no code changes.
+summary: Vallkey runtime integration for Net::HTTP.
 test_files: []