tax_conformance_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a30a2eddf0c383ace1ac9ad16038f9dd531c92ef577cb95c0a8c01f5ec6a7baf
+  data.tar.gz: 21061dff0f74ab49a0f194304e645d2c015e71352b7bdd32f9e4d47454b7376a
+SHA512:
+  metadata.gz: 5dd8edd5f14f151ace599d3cc088b85ee8be81326280e4d0752c295578c8b665a0257aa87f87536698595a668ddab06f984d33dae4d380e3d331f68d80e89268
+  data.tar.gz: edd8bcb53f6740ee483389afc0e799f6e54dfc16215e14f5dd7220372bfbbe734eef85cad9e9e4873dd2f227484862964483afa1bfdef4ec56f37403d5e1fbb4

data/README.md

@@ -0,0 +1,40 @@
+# tax_conformance_kit
+
+Thin Ruby client for the `tax-conformance-kit` Go runtime.
+
+## Install
+
+Path dependency:
+
+```ruby
+gem "tax_conformance_kit", path: "../tax-conformance-kit/clients/ruby"
+```
+
+Git dependency:
+
+```ruby
+gem "tax_conformance_kit", git: "https://github.com/ramones/tax-conformance-kit.git", glob: "clients/ruby/*.gemspec"
+```
+
+## Usage
+
+```ruby
+require "tax_conformance_kit"
+
+client = TaxConformanceKit::TaxctlClient.new(
+  command: ["/path/to/taxctl"],
+  registry_path: "/path/to/kind-registry.v1.json"
+)
+
+response = client.evaluate(
+  ruleset: ruleset_hash,
+  booking_input: booking_input_hash
+)
+```
+
+`command:` may be either:
+
+- a binary path string, for example `"/usr/local/bin/taxctl"`
+- a full argv array, for example `["go", "run", "./cmd/taxctl"]`
+
+The client does not implement the evaluator. It shells out to the canonical Go runtime and exchanges JSON over stdin/stdout.

data/lib/tax_conformance_kit/taxctl_client.rb

@@ -0,0 +1,81 @@
+require "json"
+require "open3"
+
+module TaxConformanceKit
+  class Error < StandardError; end
+
+  class TaxctlClient
+    def initialize(command:, registry_path: nil, chdir: nil, env: {})
+      @command = normalize_command(command)
+      @registry_path = registry_path
+      @chdir = chdir
+      @env = env
+    end
+
+    def validate(ruleset:, kind_registry: nil)
+      run_json("runtime-validate", {
+        ruleset: ruleset,
+        kind_registry: kind_registry
+      })
+    end
+
+    def evaluate(ruleset:, booking_input:, kind_registry: nil)
+      run_json("runtime-evaluate", {
+        ruleset: ruleset,
+        booking_input: booking_input,
+        kind_registry: kind_registry
+      })
+    end
+
+    def evaluate_assessment(ruleset:, assessment_input:, kind_registry: nil)
+      run_json("runtime-evaluate-assessment", {
+        ruleset: ruleset,
+        assessment_input: assessment_input,
+        kind_registry: kind_registry
+      })
+    end
+
+    private
+
+    def normalize_command(command)
+      case command
+      when String
+        [command]
+      when Array
+        raise ArgumentError, "command cannot be empty" if command.empty?
+
+        command
+      else
+        raise ArgumentError, "command must be a String or Array"
+      end
+    end
+
+    def run_json(subcommand, payload)
+      argv = [*@command, subcommand]
+      argv += ["-registry", @registry_path] if @registry_path
+
+      options = { stdin_data: JSON.generate(payload) }
+      options[:chdir] = @chdir unless @chdir.nil?
+
+      stdout, stderr, status = Open3.capture3(@env, *argv, **options)
+      response = parse_response(stdout)
+
+      return response if status.success? && response["ok"]
+
+      message = response.dig("error", "message")
+      message = stderr.strip if message.nil? || message.empty?
+      raise Error, message
+    rescue Error
+      raise
+    rescue JSON::ParserError => e
+      message = stderr.strip
+      raise Error, message unless message.empty?
+
+      raise Error, "invalid taxctl response: #{e.message}"
+    end
+
+    def parse_response(stdout)
+      JSON.parse(stdout)
+    end
+  end
+end

data/lib/tax_conformance_kit/version.rb

@@ -0,0 +1,3 @@
+module TaxConformanceKit
+  VERSION = "0.1.0"
+end

data/lib/tax_conformance_kit.rb

@@ -0,0 +1,2 @@
+require_relative "tax_conformance_kit/version"
+require_relative "tax_conformance_kit/taxctl_client"

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: tax_conformance_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Urban Heroes
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Ruby adapter for runtime-validate, runtime-evaluate, and runtime-evaluate-assessment.
+email:
+- dev@urbanheroes.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tax_conformance_kit.rb
+- lib/tax_conformance_kit/taxctl_client.rb
+- lib/tax_conformance_kit/version.rb
+homepage: https://github.com/ramones/tax-conformance-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ramones/tax-conformance-kit
+  source_code_uri: https://github.com/ramones/tax-conformance-kit
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Thin Ruby client for the tax-conformance-kit Go runtime
+test_files: []