polyn 0.1.0

data/lib/polyn/serializers/json.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Polyn
+  module Serializers
+    ##
+    # Handles serializing and deserializing data to and from JSON.
+    class Json
+      def self.serialize!(nats, event, **opts)
+        validate_event_instance!(event)
+        event = event.to_h
+        validate!(nats, event, **opts)
+        JSON.generate(event)
+      end
+
+      def self.deserialize!(nats, json, **opts)
+        data = deserialize(nats, json, **opts)
+        raise data if data.is_a?(Polyn::Errors::Error)
+
+        data
+      end
+
+      def self.deserialize(nats, json, **opts)
+        data = decode(json)
+        return data if data.is_a?(Polyn::Errors::Error)
+
+        error = validate(nats, data, **opts)
+        return error if error.is_a?(Polyn::Errors::Error)
+
+        data   = Polyn::Utils::Hash.deep_symbolize_keys(data)
+        Event.new(data)
+      end
+
+      def self.decode(json)
+        JSON.parse(json)
+      rescue JSON::ParserError
+        Polyn::Errors::ValidationError.new("Polyn was unable to decode the following message: \n#{json}")
+      end
+
+      def self.validate!(nats, event, **opts)
+        result = validate(nats, event, **opts)
+        raise result if result.is_a?(Polyn::Errors::Error)
+      end
+
+      def self.validate(nats, event, **opts)
+        error = validate_cloud_event(event)
+        return error if error.is_a?(Polyn::Errors::Error)
+
+        validate_data(nats, event, **opts)
+      end
+
+      def self.validate_event_instance!(event)
+        if event.instance_of?(Polyn::Event)
+          event
+        else
+          raise Polyn::Errors::ValidationError,
+            "Can only serialize `Polyn::Event` instances. got #{event}"
+        end
+      end
+
+      def self.validate_cloud_event(event)
+        cloud_event_schema = Polyn::CloudEvent.to_h
+        validate_schema(cloud_event_schema, event)
+      end
+
+      def self.validate_data(nats, event, **opts)
+        type   = get_event_type(event)
+        return type if type.is_a?(Polyn::Errors::Error)
+
+        schema = get_schema(nats, type, **opts)
+        return schema if schema.is_a?(Polyn::Errors::Error)
+
+        validate_schema(schema, event)
+      end
+
+      def self.validate_schema(schema, event)
+        schema = JSONSchemer.schema(schema)
+        errors = schema.validate(event).to_a
+        errors = format_schema_errors(errors)
+        unless errors.empty?
+          return Polyn::Errors::ValidationError.new(combined_error_message(event,
+            errors))
+        end
+
+        errors
+      end
+
+      def self.get_event_type(event)
+        if event["type"]
+          Polyn::Naming.trim_domain_prefix(event["type"])
+        else
+          Polyn::Errors::ValidationError.new(
+            "Could not find a `type` in message #{event.inspect} \nEvery event must have a `type`",
+          )
+        end
+      end
+
+      def self.get_schema(nats, type, **opts)
+        Polyn::SchemaStore.get(nats, type, name: store_name(**opts))
+      end
+
+      def self.format_schema_errors(errors)
+        errors.map do |error|
+          "Property: `#{error['data_pointer']}` - #{error['type']} - #{error['details']}"
+        end
+      end
+
+      def self.combined_error_message(event, errors)
+        [
+          "Polyn event #{event['id']} from #{event['source']} is not valid",
+          "Event data: #{event.inspect}",
+        ].concat(errors).join("\n")
+      end
+
+      def self.store_name(**opts)
+        opts[:store_name] || Polyn::SchemaStore.store_name
+      end
+    end
+  end
+end

data/lib/polyn/utils/hash.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Polyn
+  module Utils
+    ##
+    # Utilities for hash manipulation.
+    module Hash
+      ##
+      # Deep symbolize keys of a hash.
+      #
+      # @param hash [::Hash] The hash to symbolize.
+      #
+      # @return [::Hash] The symbolized hash.
+      def self.deep_symbolize_keys(hash)
+        return hash.map { |item| deep_symbolize_keys(item) } if hash.is_a?(::Array)
+        return hash unless hash.is_a?(::Hash)
+
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = deep_symbolize_keys(value)
+        end
+      end
+
+      ##
+      # Deep stringifies keys
+      #
+      # @param hash [::Hash] The hash to stringify.
+      #
+      # @return [::Hash] The stringified hash.
+      def self.deep_stringify_keys(hash)
+        return hash.map { |item| deep_stringify_keys(item) } if hash.is_a?(::Array)
+        return hash unless hash.is_a?(::Hash)
+
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_s] = deep_stringify_keys(value)
+        end
+      end
+
+      ##
+      # Deep camelize keys
+      #
+      # @param hash [::Hash] The hash to camelize.
+      #
+      # @return [::Hash] The camelized hash.
+      def self.deep_camelize_keys(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[String.to_camel_case(key)] =
+            value.is_a?(::Hash) ? deep_camelize_keys(value) : value
+        end
+      end
+
+      ##
+      # Deep snake cases keys
+      #
+      # @param hash [::Hash] The hash to snake case.
+      #
+      # @return [::Hash] The snake cased hash.
+      def self.deep_snake_case_keys(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[String.to_snake_case(key.to_s)] =
+            value.is_a?(::Hash) ? deep_snake_case_keys(value) : value
+        end
+      end
+    end
+  end
+end

data/lib/polyn/utils/string.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Polyn
+  module Utils
+    ##
+    # Utilities for working with strings.
+    module String
+      ##
+      # Converts a string to camel case.
+      #
+      # @param str ing [String] The string to convert.
+      #
+      # @return [String] The camel cased string.
+      def self.to_camel_case(str)
+        str    = str.to_s.split("_").map(&:capitalize).join
+        str[0] = str[0].downcase
+        str
+      end
+
+      def self.to_snake_case(str)
+        str.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+           .tr("-", "_")
+           .downcase
+      end
+
+      def self.to_class_name(str)
+        str.split("_").map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/polyn/utils/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "polyn/utils/hash"
+require "polyn/utils/string"

data/lib/polyn/version.rb

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

data/lib/polyn.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Loading all our classes up front
+require "json_schemer"
+require "json"
+require "nats/client"
+require "securerandom"
+
+require "polyn/configuration"
+require "polyn/cloud_event"
+require "polyn/errors/errors"
+require "polyn/event"
+require "polyn/naming"
+require "polyn/pull_subscriber"
+require "polyn/schema_store"
+require "polyn/serializers/json"
+require "polyn/utils/utils"
+require "polyn/version"
+
+##
+# Polyn is a Reactive service framework.
+module Polyn
+  ##
+  # Publishes a message on the Polyn network.
+  #
+  # @param nats [Object] Connected NATS instance from `NATS.connect`
+  # @param type [String] The type of event
+  # @param data [any] The data to include in the event
+  # @option options [String] :source - information to specify the source of the event
+  # @option options [String] :triggered_by - The event that triggered this one.
+  # Will use information from the event to build up the `polyntrace` data
+  # @option options [String] :reply_to - Reply to a specific topic
+  # @option options [String] :header - Headers to include in the message
+  def self.publish(nats, type, data, **opts)
+    event = Event.new({
+      type:         type,
+      source:       opts[:source],
+      data:         data,
+      triggered_by: opts[:triggered_by],
+    })
+
+    json = Polyn::Serializers::Json.serialize!(nats, event, **opts)
+
+    nats.publish(type, json, opts[:reply_to], header: opts[:header])
+  end
+
+  ## Create subscription which is dispatched asynchronously
+  # and sends messages to a callback.
+  #
+  # @param nats [Object] Connected NATS instance from `NATS.connect`
+  # @param type [String] The type of event
+  # @option options [String] :queue - Queue group to add subscriber to
+  # @option options [String] :max - Max msgs before unsubscribing
+  # @option options [String] :pending_msgs_limit
+  # @option options [String] :pending_bytes_limit
+  def self.subscribe(nats, type, opts = {}, &callback)
+    nats.subscribe(type, opts) do |msg|
+      event    = Polyn::Serializers::Json.deserialize!(nats, msg.data,
+        store_name: opts[:store_name])
+      msg.data = event
+      callback.call(msg)
+    end
+  end
+
+  ##
+  # Subscribe to a pull consumer that already exists in the NATS server
+  #
+  # @param nats [Object] Connected NATS instance from `NATS.connect`
+  # @param type [String] The type of event
+  # @option options [String] :source - If the `source` portion of the consumer name
+  # is more than the `source_root`
+  def self.pull_subscribe(nats, type, **opts)
+    Polyn::PullSubscriber.new({ nats: nats, type: type, source: opts[:source] })
+  end
+
+  # nats-pure will create a consumer if the one you passed does not exist.
+  # Polyn wants to avoid this functionality and instead encourage
+  # consumer creation in the centralized `events` codebase so that
+  # it's documented, discoverable, and polyn-cli can manage it
+  def self.validate_consumer_exists!(nats, stream, consumer_name)
+    nats.jetstream.consumer_info(stream, consumer_name)
+  rescue NATS::JetStream::Error::NotFound
+    raise Polyn::Errors::ValidationError,
+      "Consumer #{consumer_name} does not exist. Use polyn-cli to create "\
+      "it before attempting to subscribe"
+  end
+
+  ##
+  # Configuration information for Polyn
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  ##
+  # Configuration block to configure Polyn
+  def self.configure
+    yield(configuration)
+  end
+end

data/polyn.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2021-2022 Spiff, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require_relative "lib/polyn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "polyn"
+  spec.version       = Polyn::VERSION
+  spec.authors       = ["Jarod", "Brandyn Bennett"]
+  spec.email         = ["jarod.reid@spiff.com", "brandyn.bennett@spiff.com"]
+
+  spec.summary       = "Polyn Service Framework"
+  spec.description   = "A lightweight reactive microservice framework."
+  spec.homepage      = "https://github.com/spiffinc/polyn-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json_schemer", "~> 0.2"
+  spec.add_dependency "nats-pure", "~> 2.0"
+  spec.add_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: polyn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jarod
+- Brandyn Bennett
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: nats-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A lightweight reactive microservice framework.
+email:
+- jarod.reid@spiff.com
+- brandyn.bennett@spiff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/cloud-event-schema.json
+- lib/polyn.rb
+- lib/polyn/cloud_event.rb
+- lib/polyn/configuration.rb
+- lib/polyn/errors/configuration_error.rb
+- lib/polyn/errors/error.rb
+- lib/polyn/errors/errors.rb
+- lib/polyn/errors/schema_error.rb
+- lib/polyn/errors/validation_error.rb
+- lib/polyn/event.rb
+- lib/polyn/naming.rb
+- lib/polyn/pull_subscriber.rb
+- lib/polyn/schema_store.rb
+- lib/polyn/serializers/json.rb
+- lib/polyn/utils/hash.rb
+- lib/polyn/utils/string.rb
+- lib/polyn/utils/utils.rb
+- lib/polyn/version.rb
+- polyn.gemspec
+homepage: https://github.com/spiffinc/polyn-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/spiffinc/polyn-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Polyn Service Framework
+test_files: []