metlo 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7dab8a87de75917621db9f5fc7fce2a83f7b091c4313aa8866b7f343a6041614
+  data.tar.gz: 12ba86ba722e819bcbaa2d0795cafff2f84d0b936ca001174f0851b1f5ed7858
+SHA512:
+  metadata.gz: f509824702a561ae6b30e904ca243ba7cf256153ab5eaedbe8e424522a16cabc87c04d26475f0681033982e75fc2c85090c0d5d1624cb32b792251ed81130b0b
+  data.tar.gz: 92911c34cb1b820a508b0fccef945d5444876f80e73f8de2c82eb8b2555cad494194d64839cf4a734853bf65ac69142ce50cb0d7f325c9cbc5f4aec3c0942390

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

data/Gemfile

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

data/README.md

@@ -0,0 +1,19 @@
+# Metlo
+
+The Metlo agent for ruby frameworks able to utilize rack based middleware
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metlo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install metlo

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/lib/metlo/version.rb

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

data/lib/metlo.rb

@@ -0,0 +1,152 @@
+require "json"
+require "logger"
+require_relative "metlo/version"
+
+module Metlo
+
+    class Metlo
+        
+        @@MAX_RES_ITER_COUNT = 10
+        @@MAX_BODY_LENGTH = 10 * 1024
+        @@LOG_LEVELS = ["trace","debug","info","warn","error"]
+
+        def initialize(app, params = {})
+            p "METLO: Ruby OS/ARCHITECTURE (" + RUBY_PLATFORM + ") is not supported by Metlo currently."
+            p "METLO: Metlo is running in compatibilty mode. Trace capture and blocking operations are not available in this mode."
+            
+            @app = app
+            @disable = false
+            @block_fn = method(:metlo_default_block)
+            @get_user = nil            
+
+            metlo_url = params[:metlo_url]
+            api_key = params[:api_key]
+            backend_port = params[:backend_port]
+            collector_port = params[:collector_port]
+            encryption_key = params[:encryption_key]
+            log_level = params[:log_level]
+            block_response = params[:block_response]
+            get_user = params[:get_user]
+            
+            if not (log_level.nil?) 
+                if not (log_level.is_a? String)
+                    log_level = "info"
+                    @logger = Logger.new($stdout,convert_log_level(log_level))
+                    @logger.warn("log_level is not a string. log_level is expected to be one of trace, debug, info, warn, error.\nDefaulting log level to info.")
+                elsif not (@@LOG_LEVELS.include? log_level)
+                    log_level = "info"
+                    @logger = Logger.new($stdout,convert_log_level(log_level))
+                    @logger.warn("log_level is not one of trace, debug, info, warn, error.\nDefaulting log level to info")
+                end
+            else
+                log_level = "info"
+                @logger = Logger.new($stdout,convert_log_level(log_level))
+            end
+
+            setup_log(@logger)
+            
+            # Metlo URL
+            if not (metlo_url.is_a? String)
+                @logger.warn("metlo_url is not a string")
+                @disable = true
+            end
+
+            # Metlo API Key
+            if not (api_key.is_a? String)
+                @logger.warn("api_key is not a string")
+                @disable = true
+            end
+
+            # Backend Port
+            if not (backend_port.nil?)
+                # Value is present
+                if not (backend_port.is_a? Integer)
+                    @logger.warn("backend_port is not an integer")
+                    @disable = true
+                end
+            else
+                # Value missing.
+                if metlo_url.is_a? String and metlo_url.include? "app.metlo.com"
+                    backend_port = 443
+                else
+                    backend_port = 8000
+                end
+            end
+
+            # Collector Port
+            if not (collector_port.nil?)
+                if not (collector_port.is_a? Integer)
+                    @logger.warn("collector_port is not an integer")
+                    @disable = true
+                end 
+            else
+                collector_port = 8081
+            end
+
+            if not (encryption_key.nil?) and not (encryption_key.is_a? String)
+                @logger.warn("Encryption key is expected to be a string.")
+                encryption_key = nil
+            end
+            
+            if not (block_response.nil?)
+                if not defined? block_response == "expression"
+                    @logger.warn("block_response param is expected to be a symbol to a method/function")
+                    @block_fn = method(:metlo_default_block)
+                else
+                    if not(((defined? method(block_response)) == "method") and (method(block_response).arity == 1))
+                        @logger.warn("block_response param is expected to be a method that takes a single param")
+                        @block_fn = method(:metlo_default_block)
+                    else
+                        @block_fn = method(block_response)
+                    end
+                end
+            else
+                @block_fn = method(:metlo_default_block)
+            end
+
+
+            if not (get_user.nil?)
+                if not (defined? get_user == "expression" and defined? method(get_user) == "method" and method(get_user).arity == 1)
+                    @logger.warn("get_user param is expected to be a method that takes a single param env")
+                    @get_user = nil
+                else
+                    @get_user = method(get_user)
+                end
+            end
+        end
+
+        def call(env)
+            @app.call(env)
+        end
+
+        private
+
+        def metlo_default_block(env)
+            return [403,{},["Forbidden"]]
+        end
+
+        def setup_log(logger)
+            logger.formatter = proc do |severity, datetime, _progname, msg|
+                datefmt = datetime.strftime('%Y-%m-%dT%H:%M:%S.%6N')
+                "[timestamp=#{datefmt} level=#{severity.ljust(5)}] Metlo: #{msg}\n"
+              end              
+        end
+
+        def convert_log_level(level)
+            if level == "trace"
+                return Logger::DEBUG
+            elsif level == "debug"
+                return Logger::DEBUG
+            elsif level == "info"
+                return Logger::INFO
+            elsif level == "warn"
+                return Logger::WARN
+            elsif level == "error"
+                return Logger::ERROR
+            else
+                return Logger::INFO
+            end                
+        end
+
+    end
+end

data/metlo.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/metlo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "metlo"
+  spec.version = Metlo::VERSION
+  spec.authors = ["Metlo"]
+  spec.description = "The Ruby Agent for Metlo"
+  spec.summary = "The Ruby Agent for Metlo"
+  spec.homepage = "https://www.metlo.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/metlo-labs/metlo"
+
+  spec.platform = Gem::Platform::RUBY
+  
+  spec.files = [
+    ".standard.yml",
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "lib/metlo.rb",
+    "lib/metlo/version.rb",
+    "metlo.gemspec",
+    "sig/metlo.rbs",
+  ]
+  spec.require_paths = ["lib"]
+
+end

data/sig/metlo.rbs

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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: metlo
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Metlo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-28 00:00:00.000000000 Z
+dependencies: []
+description: The Ruby Agent for Metlo
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/metlo.rb
+- lib/metlo/version.rb
+- metlo.gemspec
+- sig/metlo.rbs
+homepage: https://www.metlo.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.metlo.com
+  source_code_uri: https://www.github.com/metlo-labs/metlo
+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: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key: 
+specification_version: 4
+summary: The Ruby Agent for Metlo
+test_files: []