rusty_json_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e89b25e8e45ded120281d3b9b6af8a85bf5b8d0cb4f86b2f339485d629cf4dfd
+  data.tar.gz: 1c6859709cd625af4184235dc09b1dfdaf05b8d0aca6fe8998c13c8bc11c1c4b
+SHA512:
+  metadata.gz: 27da18c9402b2f91c92a75f97f31ad0eb9761aa322634e79ac4dd4b735bdb1d9e138821991a41c03648be01cc8ec1f15a13868cf96f65421b1d6a00f2bac226f
+  data.tar.gz: c09eaf66fce3eb9daa15c9ab78a23fa82276a7aeb2176ca23579936ff6bf798e7990731937662fc63c0d42ce7a6c59c45efbc4a5509722c84b3be16d1b3a481b

data/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "json_schema"
+version = "0.1.0"
+authors = ["Leszek Zalewski <leszekzalewski@fastmail.fm>"]
+edition = "2018"
+
+[lib]
+name = "json_schema"
+crate-type = ["cdylib"]
+
+[dependencies]
+jsonschema = "0.4.3"
+serde_json = "1.0"

data/README.md

@@ -0,0 +1,53 @@
+# RustyJSONSchema
+
+FFI wrapper around [`jsonschema`](https://github.com/Stranger6667/jsonschema-rs) rust library. Props go to original project.
+
+Currently during heavy development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rusty_json_schema"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rusty_json_schema
+
+## Usage
+
+Initialize schema validator
+
+```ruby
+validator = RustyJSONSchema.build(json_schema)
+```
+
+Validate events like
+
+```ruby
+validator.valid?(event_json)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/driv3r/rusty_json_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/driv3r/rusty_json_schema/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RustyJSONSchema project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/driv3r/rusty_json_schema/blob/master/CODE_OF_CONDUCT.md).

data/lib/ext/json_schema.d

@@ -0,0 +1 @@
+D:\a\rusty_json_schema\rusty_json_schema\target\x86_64-pc-windows-msvc\release\json_schema.dll: D:\a\rusty_json_schema\rusty_json_schema\src\lib.rs

data/lib/ext/libjson_schema.d

@@ -0,0 +1 @@
+/home/runner/work/rusty_json_schema/rusty_json_schema/target/x86_64-unknown-linux-gnu/release/libjson_schema.so: /home/runner/work/rusty_json_schema/rusty_json_schema/src/lib.rs

data/lib/rusty_json_schema.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+require_relative "rusty_json_schema/version"
+
+# JSON Schema validation
+#
+# ## Example
+#
+#     validator = RustyJSONSchema.build(schema) # where schema is a json string of the schema
+#     validator.valid?(event) # where event is a json string of schema
+#     # => true/false
+#
+module RustyJSONSchema
+
+  def self.build(schema)
+    RustyJSONSchema::Validator::Binding.new(schema)
+  end
+
+  class Error < StandardError; end
+
+  # Handles release of the pointer automatically
+  # with Ruby GC. This way we can intialize validator
+  # in Rust, and hold a reference in Ruby.
+  #
+  class Validator < FFI::AutoPointer
+
+    # Custom GC flow for our validator, freeing
+    # the object within Rust
+    #
+    def self.release(pointer)
+      Binding.free(pointer)
+    end
+
+    # Simple validation without actual error messages
+    #
+    def valid?(event)
+      Binding.is_valid(self, event)
+    end
+
+    # FFI container for our library.
+    #
+    module Binding
+
+      extend FFI::Library
+
+      lib_name =
+        case ::FFI::Platform::LIBSUFFIX
+        when "so", "dylib" then "libjson_schema"
+        when "dll" then "json_schema"
+        end
+
+      ffi_lib File.expand_path("ext/#{lib_name}.#{::FFI::Platform::LIBSUFFIX}", __dir__)
+
+      attach_function :new, :validator_new, [:string], Validator
+      attach_function :free, :validator_free, [Validator], :void
+      attach_function :is_valid, :validator_is_valid, [Validator, :string], :bool
+
+    end
+
+  end
+
+end

data/lib/rusty_json_schema/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RustyJSONSchema
+
+  VERSION = "0.1.0"
+
+end

data/rusty_json_schema.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/rusty_json_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "rusty_json_schema"
+  spec.version     = RustyJSONSchema::VERSION
+  spec.authors     = ["Leszek Zalewski"]
+  spec.email       = ["leszekzalewski@fastmail.fm"]
+  spec.license     = "MIT"
+  spec.homepage    = "https://github.com/driv3r/rusty_json_schema"
+  spec.summary     = "FFI wrapper around jsonschema-rs Rust library."
+  spec.description = <<-STR
+    FFI wrapper around https://github.com/Stranger6667/jsonschema-rs Rust library.
+
+    Currently during heavy development.
+  STR
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["changelog_uri"]     = "https://github.com/driv3r/rusty_json_schema/blob/main/CHANGELOG.md"
+
+  spec.files = Dir["lib/**/*", "src/**/*.rs", "rusty_json_schema.gemspec", "Cargo.toml", "LICENSE", "README.md"]
+
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "ffi", "~> 1.14"
+end

data/src/lib.rs

@@ -0,0 +1,118 @@
+use jsonschema::JSONSchema;
+use serde_json::Value;
+
+use std::ffi::CStr;
+use std::os::raw::c_char;
+
+/*
+ * Our wrapper struct for schema and schema value,
+ * we need to hold onto value in order to not have
+ * it freed up, as JSONSchema uses it as reference.
+ */
+pub struct Validator {
+    schema: &'static JSONSchema<'static>,
+    schema_value: &'static Value,
+}
+
+impl Validator {
+    /*
+     * With Box::leak we avoid freeing up of schema
+     * and schema value, we free them up separately
+     * in the Drop implementation
+     */
+    fn new(schema: Value) -> Validator {
+        let boxed_schema: &'static Value = Box::leak(Box::new(schema));
+        let boxed_compile: &'static JSONSchema<'static> = Box::leak(Box::new(JSONSchema::compile(boxed_schema).unwrap()));
+
+        Validator {
+            schema: boxed_compile,
+            schema_value: boxed_schema,
+        }
+    }
+
+    fn is_valid(&self, event: &Value) -> bool {
+        self.schema.is_valid(event)
+    }
+}
+
+impl Drop for Validator {
+    /*
+     * Free up schema with value by "materializing" them,
+     * otherwise they will leak memory.
+     */
+    fn drop(&mut self) {
+        unsafe {
+            Box::from_raw(self.schema as *const _ as *mut JSONSchema);
+            Box::from_raw(self.schema_value as *const _ as *mut Value);
+        }
+    }
+}
+
+fn to_string(ptr: *const c_char) -> &'static CStr {
+    unsafe {
+        assert!(!ptr.is_null());
+        CStr::from_ptr(ptr)
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn validator_new(c_schema: *const c_char) -> *mut Validator {
+    let raw_schema  = to_string(c_schema);
+    let schema = serde_json::from_slice(raw_schema.to_bytes()).unwrap();
+    let validator = Validator::new(schema);
+
+    Box::into_raw(Box::new(validator))
+}
+
+#[no_mangle]
+pub extern "C" fn validator_free(ptr: *mut Validator) {
+    if ptr.is_null() {
+        return;
+    }
+
+    unsafe {
+        Box::from_raw(ptr);
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn validator_is_valid(ptr: *const Validator, event: *const c_char) -> bool {
+    let validator = unsafe {
+        assert!(!ptr.is_null());
+        &*ptr
+    };
+
+    let raw_event = to_string(event);
+    let event: Value = serde_json::from_slice(raw_event.to_bytes()).unwrap();
+
+    validator.is_valid(&event)
+}
+
+#[cfg(test)]
+mod tests {
+    // Note this useful idiom: importing names from outer (for mod tests) scope.
+    use super::*;
+    use std::ffi::CString;
+    use std::{thread, time};
+
+    /*
+     * Simple sanity check if everything works together
+     */
+    #[test]
+    fn test_valid_event() {
+        let schema = CString::new("{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"array\",\"items\":[{\"type\":\"number\",\"exclusiveMaximum\":10}]}").unwrap();
+        let valid_event = CString::new("[9]").unwrap();
+        let invalid_event = CString::new("[22]").unwrap();
+
+        let c_schema_ptr: *const c_char = schema.as_ptr();
+        let c_valid_event_ptr: *const c_char = valid_event.as_ptr();
+        let c_invalid_event_ptr: *const c_char = invalid_event.as_ptr();
+
+        let validator = validator_new(c_schema_ptr);
+
+        assert!(validator_is_valid(validator, c_valid_event_ptr));
+        assert!(!validator_is_valid(validator, c_invalid_event_ptr));
+
+        validator_free(validator);
+    }
+}

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rusty_json_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leszek Zalewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: |2
+      FFI wrapper around https://github.com/Stranger6667/jsonschema-rs Rust library.
+
+      Currently during heavy development.
+email:
+- leszekzalewski@fastmail.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Cargo.toml
+- README.md
+- lib/ext/json_schema.d
+- lib/ext/json_schema.dll
+- lib/ext/json_schema.dll.exp
+- lib/ext/json_schema.dll.lib
+- lib/ext/json_schema.pdb
+- lib/ext/libjson_schema.d
+- lib/ext/libjson_schema.dylib
+- lib/ext/libjson_schema.so
+- lib/rusty_json_schema.rb
+- lib/rusty_json_schema/version.rb
+- rusty_json_schema.gemspec
+- src/lib.rs
+homepage: https://github.com/driv3r/rusty_json_schema
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/driv3r/rusty_json_schema
+  source_code_uri: https://github.com/driv3r/rusty_json_schema
+  changelog_uri: https://github.com/driv3r/rusty_json_schema/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: FFI wrapper around jsonschema-rs Rust library.
+test_files: []