app_bridge 0.6.0-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbac4e3f1110df2e77bd8ee08bd108691a7c820381f6720e84e9d76a84177dd9
+  data.tar.gz: 77d9173a687a3de9aa4fb47425af3ccba303933dfbf5d2a8507ef5c137f49d11
+SHA512:
+  metadata.gz: b234de1a378380594688bf04432981243ce8cac48d7c662b47be94bda1a6830c952db19ffb7cafba86cae09bff3f5477315e6d280b4b980fb66390453ac2f154
+  data.tar.gz: e3710be91f912392f2e962a49a8dfe6d4fbce8182795e9a03655c0724a4be0d53c3b99ca70be8a1d3e0e9289cf00d30bf40f68acdf3afa6a940bd76bec74d873

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - '*.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-27
+
+- Initial release

data/README.md

@@ -0,0 +1,73 @@
+# Standout App Bridge
+
+`app_bridge` is a Ruby gem designed to facilitate communication with WebAssembly components that implement the WIT specification `standout:app`. This gem is developed for use in Standout's products.
+
+## Installation
+
+Add the following line to your `Gemfile`:
+
+```ruby
+gem 'app_bridge', github: 'standout/app_bridge'
+```
+
+Then, install the gem by running:
+
+```bash
+bundle install
+```
+
+## Usage
+
+To use this gem, you need a WebAssembly component that adheres to the specification defined in `ext/app_bridge/wit/world.wit`.
+
+You can check out the example components in `spec/fixtures/components` to see how such a component should be structured.
+
+Once you have a WebAssembly component, you can use the gem as follows:
+
+```ruby
+require 'app_bridge'
+
+app = AppBridge::App.new('path/to/your/component.wasm')
+app.triggers # => ['trigger1', 'trigger2']
+```
+
+More documentation and features will be added as the gem evolves.
+
+## Development
+
+To contribute or modify this gem, ensure you have the following dependencies installed:
+
+- **Ruby 3.3.0** (or later)
+- **Rust 1.84.0** (or later)
+
+### Setting Up the Development Environment
+
+Run the following command to setup and install additional dependencies:
+
+```bash
+bin/setup
+```
+
+Then, to compile example applications, run tests, and perform syntax checks, execute:
+
+```bash
+rake
+```
+
+### Useful Commands
+
+- **Interactive Console:** Run `bin/console` to interactively test the code.
+- **Full Test Suite & Linting:** Run `rake` to compile, execute tests, and perform syntax checks.
+- **Run Tests Only:** Execute `rake spec` to run only the test suite.
+- **Linting:** Run `rake rubocop` to check code style and formatting.
+- **Compile Example Applications:** Use `rake fixtures` to build the example apps.
+
+To install this gem locally for testing purposes, run:
+
+```bash
+bundle exec rake install
+```
+
+## Release & Distribution
+
+This gem is **not** published to RubyGems. It is intended for internal use within Standout's products only.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("app_bridge.gemspec")
+
+RbSys::ExtensionTask.new("app_bridge", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/app_bridge"
+end
+
+# Load all project specific rake tasks
+Dir.glob(File.expand_path("tasks/**/*.rake", __dir__)).each { |file| load file }
+
+task default: %i[fixtures compile spec rubocop]

data/ext/app_bridge/wit/world.wit

@@ -0,0 +1,157 @@
+package standout:app@0.3.0;
+
+interface types {
+  // The trigger-store is a string that is used to store data between trigger
+  // invocations. It is unique per trigger instance and is persisted between
+  // invocations.
+  //
+  // You can store any string here. We suggest that you use a serialized
+  // JSON object or similar since that will give you some flexibility if you
+  // need to add more data to the store.
+  type trigger-store = string;
+
+  record account {
+    id: string,
+    name: string,
+    // The account data is a JSON object serialized into a string. The JSON root
+    // will always be an object.
+    serialized-data: string,
+  }
+
+  record trigger-context {
+    // Trigger ID is a unique identifier for the trigger that is requested to be
+    // invoked.
+    trigger-id: string,
+
+    // The account that the trigger is invoked for.
+    account: account,
+
+    // The store will contain the data that was stored in the trigger store the
+    // last time the trigger was invoked.
+    store: trigger-store,
+  }
+
+  record trigger-response {
+    // The trigger events, each event will be used to spawn a new workflow
+    // execution in Standouts integration plattform.
+    events: list<trigger-event>,
+
+    // The updated store will be stored and used the next time the trigger is
+    // invoked.
+    store: trigger-store,
+  }
+
+  record trigger-event {
+    // The ID of the trigger event
+    //
+    // If the account used for the given instance of the trigger is the same,
+    // as seen before. Then the event will be ignored.
+    //
+    // A scheduler could therefore use an timestamp as the ID, to ensure that
+    // the event is only triggered once per given time.
+    //
+    // A trigger that acts on created orders in a e-commerce system could use
+    // the order ID as the ID, to ensure that the event is only triggered once
+    // per order.
+    //
+    // A trigger that acts on updated orders in a e-commerce system could use
+    // the order ID in combination with an updated at timestamp as the ID, to
+    // ensure that the event is only triggered once per order update.
+    id: string,
+
+    // The timestamp of the event.
+    // Must be a unix timestamp in milliseconds since epoch (UTC).
+    // In JavaScript `Date.now()` can be used to get the current timestamp in
+    // milliseconds.
+    timestamp: u64,
+
+    // Serialized data must be a JSON object serialized into a string
+    // Note that it is important that the root is a object, not an array,
+    // or another primitive type.
+    serialized-data: string,
+  }
+}
+
+
+interface triggers {
+  use types.{trigger-context, trigger-event, trigger-response};
+
+  get-triggers: func() -> list<string>;
+
+  // Fetch events
+  //
+  // There are some limitations to the function:
+  // - It must return within 30 seconds
+  // - It must return less than or equal to 100 events
+  //
+  // If you need to fetch more events, you can return up to 100 events and then
+  // store the data needed for you to remember where you left off in the store.
+  // The next time the trigger is invoked, you can use the store to continue
+  // where you left off.
+  //
+  // If you do not pass the limitations the return value will be ignored. We
+  // will not handle any events and we persist the store that was returned in
+  // the response.
+  //
+  // That also means that you should implement your fetch event function in a
+  // way that it can be called multiple times using the same context and return
+  // the same events. That will ensure that the user that is building an
+  // integration with your trigger will not miss any events if your system is
+  // down for a short period of time.
+  fetch-events: func(context: trigger-context) -> trigger-response;
+}
+
+interface http {
+  record response {
+    status: u16,
+    headers: headers,
+    body: string,
+  }
+
+  record request {
+    method: method,
+    url: string,
+    headers: headers,
+    body: string,
+  }
+
+  variant request-error {
+    other(string)
+  }
+
+  type headers = list<tuple<string, string>>;
+
+  resource request-builder {
+    constructor();
+
+    method: func(method: method) -> request-builder;
+    url: func(url: string) -> request-builder;
+
+    // Add a header to the request
+    header: func(key: string, value: string) -> request-builder;
+    headers: func(headers: list<tuple<string, string>>) -> request-builder;
+
+    // Add a body to the request
+    body: func(body: string) -> request-builder;
+
+    object: func() -> request;
+
+    // Send the request
+    send: func() -> result<response, request-error>;
+  }
+
+  variant method {
+    get,
+    post,
+    put,
+    delete,
+    patch,
+    options,
+    head,
+  }
+}
+
+world bridge {
+  import http;
+  export triggers;
+}

data/lib/app_bridge/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AppBridge
+  VERSION = "0.6.0"
+end

data/lib/app_bridge.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "app_bridge/version"
+require_relative "app_bridge/app_bridge"
+
+module AppBridge
+  class Error < StandardError; end
+
+  # Represents a trigger event that is recieved from the app.
+  class TriggerEvent
+    def inspect
+      "#<AppBridge::TriggerEvent(id: #{id.inspect}, timestamp: #{timestamp.inspect}, " \
+        "serialized_data: #{serialized_data.inspect})>"
+    end
+  end
+end

data/sig/app_bridge.rbs

@@ -0,0 +1,10 @@
+module AppBridge
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class App
+    def initialize: (String) -> void
+
+    def triggers : () -> Array[String]
+  end
+end

data/tasks/fixtures.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "English"
+
+namespace :fixtures do
+  namespace :apps do
+    desc "Clean up build artifacts"
+    task :clean do
+      # In context of the path spec/fixtures/components/example.
+      # Execute cargo clean.
+      #
+      pwd = "spec/fixtures/components/example"
+      pid = Process.spawn("cargo clean", chdir: pwd)
+      Process.wait(pid)
+      raise "Failed to clean build artifacts" unless $CHILD_STATUS.success?
+
+      # Remove the built wasm artifact.
+      pid = Process.spawn("rm example.wasm", chdir: "spec/fixtures/components")
+      Process.wait(pid)
+    end
+
+    desc "Compile the fixture apps"
+    task :compile do
+      pwd = "spec/fixtures/components/example"
+      compile_pid = Process.spawn("cargo clean && cargo build --release --target wasm32-wasip2",
+                                  chdir: pwd)
+      Process.wait(compile_pid)
+      raise "Failed to build artifacts" unless $CHILD_STATUS.success?
+
+      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/example.wasm #{pwd}/../example.wasm")
+      Process.wait(move_pid)
+    end
+  end
+end
+
+desc "Build all fixtures"
+task fixtures: %i[fixtures:apps:clean fixtures:apps:compile]

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: app_bridge
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: arm64-darwin
+authors:
+- Alexander Ross
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-02-26 00:00:00.000000000 Z
+dependencies: []
+description: The app_bridge gem is designed to enable seamless interaction with WebAssembly
+  components that adhere to the WIT specification `standout:app`. It is developed
+  for use in Standout's products.
+email:
+- ross@standout.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- ext/app_bridge/wit/world.wit
+- lib/app_bridge.rb
+- lib/app_bridge/3.1/app_bridge.bundle
+- lib/app_bridge/3.2/app_bridge.bundle
+- lib/app_bridge/3.4/app_bridge.bundle
+- lib/app_bridge/version.rb
+- sig/app_bridge.rbs
+- tasks/fixtures.rake
+homepage: https://github.com/standout/app_bridge
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/standout/app_bridge
+  source_code_uri: https://github.com/standout/app_bridge
+  changelog_uri: https://github.com/standout/app_bridge/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: Communication layer for Standout integration apps
+test_files: []