turbine_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2723a945ce0de61011f1afebdd6ba874a76ab666454c611dfb36573ca546a160
+  data.tar.gz: 63b28bd099bcafa485e4d2db7f995b45defd32a110ed9cec5a543f6507f87da0
+SHA512:
+  metadata.gz: 530bb168de0ccbaa8c2eb83751268b45d5762ff662cbf63c74416eca9d5e49d5a4c4ccc30498f31fcc3b820504a387daead10d5dfad51f70d8e945f7af1bdb86
+  data.tar.gz: 62f1b54f0cca2abbf11e712563202ece58e41c4945ff0a6571d449b7b684b3dae066d687cd6e479924c03eaca5fa5f9cae1d208df543de98490d6d824d2be56b

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,38 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - lib/service_services_pb.rb
+    - lib/service_pb.rb
+    - lib/turbine_services_pb.rb
+    - lib/validate/validate_pb.rb
+    - lib/turbine_pb.rb
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+RSpec/ExampleLength:
+  Max: 20
+
+# Enable this after refactoring spec/
+RSpec/MultipleDescribes:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-11-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 57750952+ahmeroxa@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in turbine_rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "pry"
+  gem "rubocop", "~> 1.21", require: false
+  gem "rubocop-rake", "~> 0.6.0"
+  gem "rubocop-rspec", "~> 2.15"
+end
+
+group :test do
+  gem "guard-rspec"
+  gem "mocktail"
+  gem "rspec", "~> 3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    turbine_rb (0.1.0)
+      grpc (~> 1.48)
+      hash_dot (~> 2.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    google-protobuf (3.21.9)
+    google-protobuf (3.21.9-x86_64-darwin)
+    google-protobuf (3.21.9-x86_64-linux)
+    googleapis-common-protos-types (1.4.0)
+      google-protobuf (~> 3.14)
+    grpc (1.50.0)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.50.0-x86_64-darwin)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.50.0-x86_64-linux)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hash_dot (2.5.0)
+    json (2.6.2)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mocktail (1.2.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-20
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  guard-rspec
+  mocktail
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.15)
+  turbine_rb!
+
+BUNDLED WITH
+   2.3.7

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,3 @@
+Copyright Ⓒ 2022 Meroxa Inc.
+
+All code in this repository is copyrighted and proprietary. It is not licensed for usage, distribution and/or modification of any kind.

data/README.md

@@ -0,0 +1,223 @@
+# TurbineRb
+> PLEASE NOTE: TurbineRB is currently a work in progress, and the following features may or may not be ready
+
+Turbine is a data application framework for building server-side applications that are event-driven, respond to data in real-time, and scale using cloud-native best practices
+
+The benefits of using Turbine include:
+
+* **Native Developer Tooling:** Turbine doesn't come with any bespoke DSL or patterns. Write software like you normally would!
+
+* **Fits into Existing DevOps Workflows:** Build, test, and deploy. Turbine encourages best practices from the start. Don't test your data app in production ever again.
+
+* **Local Development mirrors Production:** When running locally, you'll immediately see how your app reacts to data. What you get there will be exactly what happens in production but with _scale_ and _speed_.
+
+* **Available in many different programming langauages:** Turbine started out in Go but is available in other languages too:
+    * [Go](https://github.com/meroxa/turbine-go)
+    * [Javascript](https://github.com/meroxa/turbine-js)
+    * [Python](https://github.com/meroxa/turbine-py)
+    * [Ruby](https://github.com/meroxa/turbine-core/tree/main/lib/ruby/turbine_rb)
+
+
+## Getting Started
+> PLEASE NOTE: This Meroxa CLI `init` command is not yet implemented for ruby apps, coming soon!
+
+To get started, you'll need to [download the Meroxa CLI](https://github.com/meroxa/cli#installation-guide). Once downloaded and installed, you'll need to back to your terminal and initialize a new project:
+
+```bash
+$ meroxa apps init testapp --lang ruby
+```
+
+The CLI will create a new folder called `testapp` located in the directory where the command was issued. If you want to initialize the app somewhere else, you can append the `--path` flag to the command (`meroxa apps init testapp --lang ruby --path ~/anotherdir`). Once you enter the `testapp` directory, the contents will look like this:
+
+```bash
+$ tree testapp/
+testapp
+├── app.rb
+├── Gemfile
+├── Gemfile.lock
+└── fixtures
+    └── demo.json
+```
+
+This will be a full-fledged Turbine app that can run. It provides just enough to show you what you need to get started.
+
+### `app.rb`
+
+This configuration file is where you begin your Turbine journey. Any time a Turbine app runs, this is the entry point for the entire application. When the project is created, the file will look like this:
+
+```rb
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler/setup'
+require 'turbine_rb'
+
+# Define your function
+class Passthrough < TurbineRb::Process
+  def call(records:)
+    records.each do |record|
+      puts record.get("message")
+    end
+
+    records
+  end
+end
+
+# Define your app configuration with your function
+class MyApp
+  def call(app)
+    database = app.resource(name: 'demopg')
+
+    # procedural API
+    records = database.records(collection: 'events')
+
+    # This register the secret to be available in the turbine application
+    app.register_secrets("MY_ENV_TEST")
+
+    # you can also register several secrets at once
+    # app.register_secrets(["MY_ENV_TEST", "MY_OTHER_ENV_TEST"])
+
+    processed_records = app.process(records: records, process: Passthrough.new) # Passthrough just has to match the signature
+    database.write(records: processed_records, collection: "events_copy")
+  end
+end
+
+
+# Register your app with Turbine
+TurbineRb.register(MyApp.new)
+```
+
+Let's talk about the important parts of this code. Turbine apps have five methods that comprise the entire DSL. Outside of these methods, you can write whatever code you want to accomplish your tasks:
+
+```rb
+call(app)
+```
+
+`call` is the main entry point for the application. This is where you can initialize the Turbine framework. This is also the place where, when you deploy your Turbine app to Meroxa, Meroxa will use this as the place to boot up the application.
+
+```rb
+database = app.resource(name: 'demopg')
+```
+
+The `resource` method identifies the upstream or downstream system that you want your code to work with. The `name` is the string identifier of the particular system. The string should map to an associated identifier in your `app.json` to configure what's being connected to. For more details, see the `app.json` section.
+
+```rb
+records = database.records(collection: 'events')
+```
+
+Once you've got `resource` set up, you can now stream records from it, but you need to identify what records you want. The `records` method identifies the records or events that you want to stream into your data app.
+
+```rb
+processed_records = app.process(records: records, process: Passthrough.new)
+```
+
+The `process` method is Turbine's way of saying, for the records that are coming in, I want you to process these records against a function. Once your app is deployed on Meroxa, Meroxa will do the work to take each record or event that does get streamed to your app and then run your code against it. This allows Meroxa to scale out your processing relative to the velocity of the records streaming in.
+
+```rb
+database.write(records: processed_records, collection: "events_copy")
+```
+
+The `write` method is optional. It takes any records given to it and streams them to the downstream system. In many cases, you might not need to stream data to another system, but this gives you an easy way to do so.
+
+
+#### Function API
+The function passed to `process` is defined by the user with the following signature
+```rb
+class Passthrough < TurbineRb::Process
+  def call(records:)
+    records
+  end
+end
+```
+
+The `records` parameter is an array of records that can be iterated on. Each `record` in the `records` array comes with some handy methods for reading from/writing to the record's data as it passes through the function.
+
+These methods are the preferred way for accessing data. They will work regardless if the data is CDC formatted or not (as long as the actual payload data is a valid JSON object)
+
+
+```rb
+record.get('key') # Will retrieve the value at `key`
+```
+
+
+
+```rb
+record.set('key', 'some value') # Will set `some_value` at `key`
+```
+
+
+The `records` parameter itself comes with an optional but important method
+
+```rb
+records.unwrap!;
+```
+
+A user can optionally use this transform in their data app function to unwrap CDC formatted records into the right format that destinations expect. Currently, most destinations will not accept CDC formatted data. **_(s3 being an exception)_**
+
+A user **_will_** want to call this when records are going to any destination (usually at the end of the data app function).
+
+A user **_will not_** want to call this when the records are going to an s3 destination AND they need the CDC format preserved
+
+Note that this function only operates on CDC formatted data, and no ops otherwise.
+
+### `app.json`
+
+This file contains all of the options for configuring a Turbine app. Upon initialization of an app, the CLI will scaffold the file for you with available options:
+
+```
+{
+  "name": "testapp",
+  "language": "ruby",
+  "environment": "common",
+  "resources": {
+    "source_name": "fixtures/path"
+  }
+}
+```
+
+* `name` - The name of your application. This should not change after app initialization.
+* `language` - Tells Meroxa what language the app is upon deployment.
+* `environment` - "common" is the only available environment. Meroxa does have the ability to create isolated environments but this feature is currently in beta.
+* `resources` - These are the named integrations that you'll use in your application. The `source_name` needs to match the name of the resource that you'll set up in Meroxa using the `meroxa resources create` command or via the Dashboard. You can point to the path in the fixtures that'll be used to mock the resource when you run `meroxa apps run`.
+
+### Fixtures
+
+Fixtures are JSON-formatted samples of data records you can use while locally developing your Turbine app. Whether CDC or non-CDC-formatted data records, fixtures adhere to the following structure:
+
+```json
+{
+  "collection_name": [
+    {
+      "key": "1",
+      "value": {
+		  "schema": {
+			  //...
+		  },
+		  "payload": {
+			  //...
+		  }
+		}
+	}
+  ]
+```
+* `collection_name` — Identifies the name of the records or events you are streaming to your data app.
+* `key` — Denotes one or more sample records within a fixture file. `key` is always a string.
+* `value` — Holds the `schema` and `payload` of the sample data record.
+* `schema` — Comes as part of your sample data record. `schema` describes the record or event structure.
+* `payload` — Comes as part of your sample data record. `payload` describes what about the record or event changed.
+
+Your newly created data app should have a `demo-cdc.json` and `demo-non-cdc.json` in the `/fixtures` directory as examples to follow.
+
+## Documentation && Reference
+
+The most comprehensive documentation for Turbine and how to work with Turbine apps is on the Meroxa site: [https://docs.meroxa.com/](https://docs.meroxa.com)
+
+
+## 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/[USERNAME]/turbine_rb.

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: %i[spec rubocop]

data/bin/turbine-build

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "turbine_rb"
+require File.join(Dir.getwd, "app")
+
+TurbineRb.build

data/bin/turbine-function

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "turbine_rb"
+require File.join(Dir.getwd, "app")
+
+TurbineRb.serve

data/bin/turbine-record

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "turbine_rb"
+require File.join(Dir.getwd, "app")
+
+TurbineRb.record

data/bin/turbine-run

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "turbine_rb"
+require File.join(Dir.getwd, "app")
+
+TurbineRb.run

data/lib/service_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: service.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/struct_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("service.proto", :syntax => :proto3) do
+    add_message "io.meroxa.funtime.ProcessRecordRequest" do
+      repeated :records, :message, 1, "io.meroxa.funtime.Record"
+    end
+    add_message "io.meroxa.funtime.ProcessRecordResponse" do
+      repeated :records, :message, 1, "io.meroxa.funtime.Record"
+    end
+    add_message "io.meroxa.funtime.Record" do
+      optional :key, :string, 1
+      optional :value, :string, 2
+      optional :timestamp, :int64, 3
+      optional :structured, :message, 4, "google.protobuf.Struct"
+    end
+  end
+end
+
+module Io
+  module Meroxa
+    module Funtime
+      ProcessRecordRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("io.meroxa.funtime.ProcessRecordRequest").msgclass
+      ProcessRecordResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("io.meroxa.funtime.ProcessRecordResponse").msgclass
+      Record = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("io.meroxa.funtime.Record").msgclass
+    end
+  end
+end

data/lib/service_services_pb.rb

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: service.proto for package 'io.meroxa.funtime'
+
+require 'grpc'
+require 'service_pb'
+
+module Io
+  module Meroxa
+    module Funtime
+      module Function
+        class Service
+
+          include ::GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'io.meroxa.funtime.Function'
+
+          rpc :Process, ::Io::Meroxa::Funtime::ProcessRecordRequest, ::Io::Meroxa::Funtime::ProcessRecordResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/lib/templates/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:3.1.2
+WORKDIR /app
+COPY . .
+RUN bundle install
+USER nobody
+ENTRYPOINT ["bundle exec turbine-function"]

data/lib/templates/app/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "turbine_rb"

data/lib/templates/app/app.json

@@ -0,0 +1,8 @@
+{
+    "name": "ruby-example",
+    "language": "ruby",
+    "environment": "common",
+    "resources": {
+        "demopg": "fixtures/demo.json"
+    }
+}