ballistics-engine 0.36.0 → 0.36.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2879a18b72e21e57061c85dcbe920e5457590522135f7b0285a14902b842498
-  data.tar.gz: 47be0e871d522917fe87eaf49167388b7824204114d9149144ae7151e82de179
+  metadata.gz: f88aa4eaac01368235e15f61a52b72e1b8115309919889ba156ee33080a829ef
+  data.tar.gz: 101737d4006e8909bc665a1a34b05fc52d9112f1838a9e515e6a629140f733c3
 SHA512:
-  metadata.gz: b7742cc9824f85e478f4484e2ce7cbda7e8019ac4112ea436304b65f471d9e19944134d69dbe681a18a91651e822fca50fef767cad6af8a1d4da42e3501febd9
-  data.tar.gz: 3373dfd90aa6d1d08f03a34b977f56e01746e9373d9f96e199bd5e10a84ccb59dbbd6fd935e319b227a3779a49400749c9456fda7ddaaebcba71f938712de8e0
+  metadata.gz: bbca3d10f6cab28fd96619daeebc59dc96f418329ef44286c2ce8dac0defb9e3de9136659f7e5a72fbfbc852f3a85029fe349eb68c741cb95c38a7a560ff70b6
+  data.tar.gz: 7e1829e71d9e15a17c4cdfe3105e35d497ef633d6f56ae68e85f0eff9bed896ab237d19c71b57357a723cce83b940719c4a7c829315dbec8d952ceca02323070

data/Cargo.lock

@@ -43,9 +43,9 @@ checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
 
 [[package]]
 name = "ballistics-engine"
-version = "0.36.0"
+version = "0.36.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "23568cd57f14599a74cb75d839836007a5ec9659c29e583897a378275e630976"
+checksum = "8d9c76ab7ca6a459f91b3876b61955b3a366615ab04947e7aa220efde77ef520"
 dependencies = [
  "getrandom",
  "js-sys",
@@ -65,7 +65,7 @@ dependencies = [
 
 [[package]]
 name = "ballistics_engine_rb"
-version = "0.36.0"
+version = "0.36.1"
 dependencies = [
  "ballistics-engine",
  "magnus",

data/Cargo.toml

@@ -3,7 +3,7 @@
 # rake-compiler/rb-sys cargo-metadata lookup resolves (newer rb-sys does not
 # normalize hyphens). The published gem name is set in the gemspec, independent.
 name = "ballistics_engine_rb"
-version = "0.36.0"
+version = "0.36.1"
 edition = "2021"
 authors = ["Alex Jokela <email@tinycomputers.io>"]
 description = "Ruby bindings for ballistics-engine"
@@ -15,7 +15,10 @@ name = "ballistics_engine_rb"
 crate-type = ["cdylib"]
 
 [dependencies]
-ballistics-engine = { version = "0.36.0", default-features = false }
+# `bridge` exposes ballistics_engine::bridge::bridge_call — the versioned JSON command
+# bridge that reaches every engine command from one string-in/string-out entry point.
+# It is pure serde/serde_json (already core engine deps), so it adds no new dependencies.
+ballistics-engine = { version = "0.36.1", default-features = false, features = ["bridge"] }
 magnus = "0.8"
 
 [profile.release]

data/README.md

@@ -10,6 +10,8 @@ High-performance ballistics calculations library for Ruby, powered by Rust.
 - **Atmospheric Effects** - Temperature, pressure, humidity, and altitude compensation
 - **Unit Conversion** - Automatic handling of imperial/metric conversions
 - **High Performance** - Rust-based calculations for maximum speed
+- **JSON Command Bridge** - `bridge_call` reaches every engine command (solve, dope
+  cards, profiles, truing) through one versioned JSON envelope
 
 ## Installation
 
@@ -133,6 +135,62 @@ keys** in imperial units. Unknown keys are ignored; only the seven marked requir
 y=drop, z=windage, in yards). Present when enabled: `sampled_points`, `aerodynamic_jump`,
 `angular_state`, `max_yaw_angle_rad`, `max_precession_angle_rad`, `min_pitch_damping`, `transonic_mach`.
 
+### `BallisticsEngine.bridge_call(request_json) => String`
+
+Raw pass-through to the engine's versioned JSON command bridge: one full request
+envelope in as a String, one full response envelope out as a String. Nothing is parsed
+and nothing is raised — the bridge never panics and reports every failure in band as
+`{"ok":false,"error":{...}}`, so the caller owns the envelope.
+
+```ruby
+require "json"
+
+def bridge(command, request)
+  JSON.parse(BallisticsEngine.bridge_call(
+    JSON.generate("api_version" => 1, "command" => command, "request" => request)
+  ))
+end
+
+bridge("meta.version", {})
+# => {"ok"=>true, "api_version"=>1, "engine_version"=>"0.36.1",
+#     "command"=>"meta.version", "result"=>{"engine_version"=>"0.36.1"}}
+
+# Every command reachable in this build:
+bridge("meta.capabilities", {})["result"]["commands"]
+# => ["meta.capabilities", "meta.version", "solve", "card.come_ups", "card.range_table",
+#     "card.wind", "profile.validate", "profile.normalize", "true.fit", "true.wind",
+#     "true.tall_target", "true.dsf", "true.plan", "true.dial_plan", "bc5d.info"]
+```
+
+`command` is one of the names `meta.capabilities` reports; `request` is that command's
+own document. `solve` takes a [solve-json v1](https://github.com/ajokela/ballistics-engine/blob/main/docs/SOLVE_JSON_V1.md)
+document — strict SI units, unknown fields rejected with a JSON path — and is the only
+way to reach fields the hash API above has no key for, such as
+`atmosphere.pressure_reference` (QNH altimeter settings) and
+`corrections.bc5d_table_path`:
+
+```ruby
+r = bridge("solve", {
+  "schema_version" => 1,
+  "projectile" => { "mass_kg" => 0.01134, "diameter_m" => 0.00782,
+                    "drag_model" => "G7", "ballistic_coefficient" => 0.243 },
+  "rifle"      => { "muzzle_velocity_mps" => 823.0, "sight_height_m" => 0.05 },
+  "shot"       => { "max_range_m" => 1000.0, "zero_distance_m" => 100.0 },
+  "atmosphere" => { "altitude_m" => 1200.0, "pressure_pa" => 101_325.0,
+                    "pressure_reference" => "qnh" },
+  "wind"       => { "speed_mps" => 4.4704, "direction_from_rad" => Math::PI / 2 },
+  "solver"     => { "method" => "rk45" },
+  "effects"    => { "wind_shear_model" => "power_law" },
+  "sampling"   => { "interval_m" => 100.0 }
+})
+r["ok"]                                   # => true
+r["result"]["samples"].last["windage_m"]  # => -2.7677...
+```
+
+The `pdf` / `card.pdf` and `profile.import_a7p` commands are compiled out of this gem
+(it builds the engine with `default-features = false`); `meta.capabilities` lists only
+what this build can actually run.
+
 ### `BallisticsEngine.calculate_zero_angle(hash) => hash`
 
 Same bullet keys as `solve`, plus **required** `target_distance_yards` (and optional

data/lib/ballistics_engine.rb

@@ -4,7 +4,7 @@ require "ballistics_engine_rb"
 
 # Top-level module for the BallisticsEngine gem
 module BallisticsEngine
-  VERSION = "0.36.0"
+  VERSION = "0.36.1"
 
   class Error < StandardError; end
 end

data/src/lib.rs

@@ -416,11 +416,38 @@ fn monte_carlo(ruby: &magnus::Ruby, h: RHash) -> Result<RHash, Error> {
     Ok(out)
 }
 
+/// Raw pass-through to the engine's versioned JSON command bridge.
+///
+/// One string in (a full request envelope), one string out (a full response envelope).
+/// This is deliberately NOT a typed wrapper: `ballistics_engine::bridge::bridge_call`
+/// dispatches every bridge command — `meta.capabilities`, `meta.version`, `solve`,
+/// the `card.*` family, `profile.*`, the `true.*` truing family, `bc5d.info` — from
+/// one entry point, so mirroring the per-command DTOs here would be a large surface
+/// that goes stale on every engine release. `solve` in particular is this binding's
+/// only route to `corrections.bc5d_table_path` and `atmosphere.pressure_reference`,
+/// neither of which the hash-based `solve` above reaches; it also reaches
+/// `effects.wind_shear_model` as a validated enum (the hash surface has its own
+/// `enable_wind_shear` / `wind_shear_model` pair, which accepts any string and maps
+/// an unrecognized one to the power law rather than reporting it).
+///
+/// Failures are IN BAND: the bridge is `catch_unwind`-guarded, never panics, and
+/// reports every error as `{"ok":false,"error":{...}}` inside the returned JSON.
+/// So this raises nothing and parses nothing — the caller owns the envelope and
+/// decides whether to `JSON.parse` it.
+///
+///     env = { api_version: 1, command: "meta.version", request: {} }
+///     JSON.parse(BallisticsEngine.bridge_call(JSON.generate(env)))
+///     # => {"ok"=>true, "api_version"=>1, "engine_version"=>"0.36.1", ...}
+fn bridge_call(request_json: String) -> String {
+    ballistics_engine::bridge::bridge_call(&request_json)
+}
+
 #[magnus::init]
 fn init(ruby: &magnus::Ruby) -> Result<(), Error> {
     let module = ruby.define_module("BallisticsEngine")?;
     module.define_module_function("solve", function!(solve_trajectory, 1))?;
     module.define_module_function("calculate_zero_angle", function!(calculate_zero_angle, 1))?;
     module.define_module_function("monte_carlo", function!(monte_carlo, 1))?;
+    module.define_module_function("bridge_call", function!(bridge_call, 1))?;
     Ok(())
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ballistics-engine
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.36.1
 platform: ruby
 authors:
 - Alex Jokela