extism 0.0.1.rc4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9baa968de02938c07de67d56f468c482392d15c3b0d4856679ffa65ac54bcf8e
+  data.tar.gz: 18577dac8681ec65162505ea3664ec85d39be3c7b97df203a12f89a0eeff1617
+SHA512:
+  metadata.gz: ffc8f845fc8d42e6f55dc90bc56ab6e4b2ad35f1a1af88c4a5caf1c8f0353314be92e2e33157eb9c50c9a7d168d477d78c7af883f7d30f5879f27e53e4b34f0f
+  data.tar.gz: cf4175f208e06380f761ff80dec20ac38a416e7c866cee1ccb3844a37e24369464eeb4a60bcd547b7e348fc00744d06de8cceda5cfcd87dc9675d45bdbb407f4

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in extism.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "ffi"
+

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/example.rb

@@ -0,0 +1,16 @@
+require './lib/extism'
+require 'json'
+
+# a Context provides a scope for plugins to be managed within. creating multiple contexts
+# is expected and groups plugins based on source/tenant/lifetime etc.
+ctx = Extism::Context.new
+Extism::with_context {|ctx| 
+  manifest = {
+    :wasm => [{:path => "../wasm/code.wasm"}]
+  }
+
+  plugin = ctx.plugin(manifest)
+  res = JSON.parse(plugin.call("count_vowels", ARGV[0] || "this is a test"))
+  
+  puts res['count']
+}

data/lib/extism/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Extism
+  VERSION = "0.0.1.rc4"
+end

data/lib/extism.rb

@@ -0,0 +1,183 @@
+require 'ffi'
+require 'json'
+
+module Extism
+  module C
+    extend FFI::Library
+    ffi_lib "extism"
+    attach_function :extism_context_new, [], :pointer
+    attach_function :extism_context_free, [:pointer], :void
+    attach_function :extism_plugin_new, [:pointer, :pointer, :uint64, :bool], :int32
+    attach_function :extism_plugin_update, [:pointer, :int32, :pointer, :uint64, :bool], :bool
+    attach_function :extism_error, [:pointer, :int32], :string
+    attach_function :extism_plugin_call, [:pointer, :int32, :string, :pointer, :uint64], :int32
+    attach_function :extism_plugin_function_exists, [:pointer, :int32, :string], :bool
+    attach_function :extism_plugin_output_length, [:pointer, :int32], :uint64
+    attach_function :extism_plugin_output_data, [:pointer, :int32], :pointer
+    attach_function :extism_log_file, [:string, :pointer], :void
+    attach_function :extism_plugin_free, [:pointer, :int32], :void
+    attach_function :extism_context_reset, [:pointer], :void
+    attach_function :extism_version, [], :string
+  end
+
+
+  class Error < StandardError
+  end
+
+  # Return the version of Extism
+  def self.extism_version
+    C.extism_version
+  end
+
+  # Set log file and level, this is a global configuration
+  def self.set_log_file(name, level=nil)
+    if level then
+      level = FFI::MemoryPointer::from_string(level)
+    end
+    C.extism_log_file(name, level)
+  end
+
+  $PLUGINS = {}
+  $FREE_PLUGIN = proc { |id|
+    x = $PLUGINS[id]
+    if !x.nil? then
+      C.extism_plugin_free(x[:context].pointer, x[:plugin])
+      $PLUGINS.delete(id)
+    end
+  }
+
+  $CONTEXTS = {}
+  $FREE_CONTEXT = proc { |id|
+    x = $CONTEXTS[id]
+    if !x.nil? then
+      C.extism_context_free($CONTEXTS[id])
+      $CONTEXTS.delete(id)
+    end
+  }
+
+  # Context is used to manage plugins
+  class Context
+    attr_accessor :pointer
+
+    def initialize
+      @pointer = C.extism_context_new()
+      $CONTEXTS[self.object_id] = @pointer
+      ObjectSpace.define_finalizer(self,  $FREE_CONTEXT)
+    end
+
+    # Remove all registered plugins
+    def reset
+      C.extism_context_reset(@pointer)
+    end
+
+    # Free the context, this should be called when it is no longer needed
+    def free
+      if @pointer.nil? then
+        return
+      end
+      $CONTEXTS.delete(self.object_id)
+      C.extism_context_free(@pointer)
+      @pointer = nil
+    end
+
+    # Create a new plugin from a WASM module or JSON encoded manifest
+    def plugin(wasm, wasi=false, config=nil)
+      return Plugin.new(self, wasm, wasi, config)
+    end
+  end
+
+
+  def self.with_context(&block)
+    ctx = Context.new
+    begin
+      x = block.call(ctx)
+      return x
+    ensure
+      ctx.free
+    end
+  end
+
+  class Plugin
+    def initialize(context, wasm, wasi=false, config=nil)
+      if wasm.class == Hash then
+        wasm = JSON.generate(wasm)
+      end
+      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
+      code.put_bytes(0, wasm)
+      @plugin = C.extism_plugin_new(context.pointer, code, wasm.bytesize, wasi)
+      if @plugin < 0 then
+        err = C.extism_error(-1)
+        if err&.empty? then
+          raise Error.new "extism_plugin_new failed"
+        else raise Error.new err
+        end
+      end
+      @context = context
+      $PLUGINS[self.object_id] = {:plugin => @plugin, :context => context}
+      ObjectSpace.define_finalizer(self,  $FREE_PLUGIN)
+      if config != nil and @plugin >= 0 then
+        s = JSON.generate(config)
+        ptr = FFI::MemoryPointer::from_string(s)
+        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
+      end
+    end
+
+    # Update a plugin with new WASM module or manifest
+    def update(wasm, wasi=false, config=nil)
+      if wasm.class == Hash then
+        wasm = JSON.generate(wasm)
+      end
+      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
+      code.put_bytes(0, wasm)
+      ok = C.extism_plugin_update(@context.pointer, @plugin, code, wasm.bytesize, wasi)
+      if !ok then
+        err = C.extism_error(-1)
+        if err&.empty? then
+          raise Error.new "extism_plugin_update failed"
+        else raise Error.new err
+        end
+      end
+
+      if config != nil then
+        s = JSON.generate(config)
+        ptr = FFI::MemoryPointer::from_string(s)
+        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
+      end
+    end
+
+    # Check if a function exists
+    def function_exists(name)
+      return C.extism_function_exists(@context.pointer, @plugin, name)
+    end
+
+    # Call a function by name
+    def call(name, data, &block)
+      # If no block was passed then use Pointer::read_string
+      block ||= ->(buf, len){ buf.read_string(len) }
+      input = FFI::MemoryPointer::from_string(data)
+      rc = C.extism_plugin_call(@context.pointer, @plugin, name, input, data.bytesize)
+      if rc != 0 then
+        err = C.extism_error(@context.pointer, @plugin)
+        if err&.empty? then
+          raise Error.new "extism_call failed"
+        else raise Error.new err
+        end
+      end
+      out_len = C.extism_plugin_output_length(@context.pointer, @plugin)
+      buf = C.extism_plugin_output_data(@context.pointer, @plugin)
+      return block.call(buf, out_len)
+    end
+
+    # Free a plugin, this should be called when the plugin is no longer needed
+    def free
+      if @context.pointer.nil? then
+        return
+      end
+
+      $PLUGINS.delete(self.object_id)
+      C.extism_plugin_free(@context.pointer, @plugin)
+      @plugin = -1
+    end
+
+  end
+end

data/sig/extism.rbs

@@ -0,0 +1,4 @@
+module Extism
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: extism
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc4
+platform: ruby
+authors:
+- zach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-20 00:00:00.000000000 Z
+dependencies: []
+description: A library for loading and executing WASM plugins
+email:
+- zachshipko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- example.rb
+- lib/extism.rb
+- lib/extism/version.rb
+- sig/extism.rbs
+- user_code.wasm
+homepage: https://github.com/extism/extism
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/extism/extism
+  source_code_uri: https://github.com/extism/extism
+  changelog_uri: https://github.com/extism/extism
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Extism WASM SDK
+test_files: []