sqreen-kit 0.1.0

data/lib/sqreen/kit/signals/metric.rb

@@ -0,0 +1,16 @@
+require 'sqreen/kit/signals/dto_helper'
+require 'sqreen/kit/signals/signal'
+
+# reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/signals.cue
+
+module Sqreen
+  module Kit
+    module Signals
+      class Metric < Signal
+        def type
+          'metric'
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/kit/signals/point.rb

@@ -0,0 +1,16 @@
+require 'sqreen/kit/signals/dto_helper'
+require 'sqreen/kit/signals/signal'
+
+# reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/signals.cue
+
+module Sqreen
+  module Kit
+    module Signals
+      class Point < Signal
+        def type
+          'point'
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/kit/signals/signal.rb

@@ -0,0 +1,28 @@
+require 'sqreen/kit/signals/dto_helper'
+require 'sqreen/kit/signals/signal_attributes'
+
+# reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/signals.cue
+
+module Sqreen
+  module Kit
+    module Signals
+      # Not to be used directly. See Metric and Point
+      class Signal
+        include SignalAttributes
+
+        add_mandatory_attrs :signal_name, :payload
+
+        # mandatory
+        # @return [String]
+        attr_accessor :signal_name
+
+        # @return [String]
+        attr_accessor :payload_schema
+
+        # mandatory
+        # @return [Object]
+        attr_accessor :payload
+      end
+    end
+  end
+end

data/lib/sqreen/kit/signals/signal_attributes.rb

@@ -0,0 +1,104 @@
+require 'sqreen/kit/signals/dto_helper'
+require 'sqreen/kit/signals/stack_trace'
+require 'sqreen/kit/signals/actor'
+
+# reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/signals.cue
+
+module Sqreen
+  module Kit
+    module Signals
+      module SignalAttributes
+        include DtoHelper
+
+        # @param [Time]
+        # @return [String]
+        attr_accessor_time :time
+
+        def type
+          raise NotImplementedError
+        end
+
+        # @return [Actor]
+        attr_accessor :actor
+
+        # @return [String]
+        attr_accessor :context_schema
+
+        # @return [Object] specified by context schema
+        attr_accessor :context
+
+        # @return [Location]
+        attr_accessor :location
+
+        # @return [LocationInfra]
+        attr_accessor :location_infra
+
+        # @return [String]
+        attr_accessor :source
+
+        # @return [Hash{String=>Object}]
+        attr_accessor :trigger
+
+        def to_h
+          {
+            type: type,
+          }.merge(super())
+        end
+      end
+
+      class Location
+        include DtoHelper
+
+        # @param [Array<String>]
+        attr_writer :stack_trace
+
+        # @param [Exception] e
+        attr_writer :exception
+
+        def stack_trace
+          if @exception
+            Sqreen::Kit::StackTrace.parse(@exception)
+          elsif @stack_trace
+            Sqreen::Kit::StackTrace.parse_backtrace(@stack_trace)
+          else
+            raise 'Neither exception not stack_trace set'
+          end
+        end
+      end
+
+      class LocationInfra
+        include DtoHelper
+
+        add_mandatory_attrs :agent_version, :os_type, :hostname, :runtime_version
+
+        # mandatory
+        # @return [String]
+        attr_accessor :agent_version
+
+        # mandatory
+        # @return [String]
+        attr_accessor :os_type
+
+        # mandatory
+        # @return [String]
+        attr_accessor :hostname
+
+        # @return [String]
+        attr_accessor :runtime_type
+
+        # mandatory
+        # @return [String]
+        attr_accessor :runtime_version
+
+        # @return [String]
+        attr_accessor :libsqreen_version
+
+        def to_h
+          {
+            agent_type: 'ruby',
+          }.merge(super())
+        end
+      end
+    end # module Signals
+  end
+end

data/lib/sqreen/kit/signals/signals_client.rb

@@ -0,0 +1,33 @@
+require 'sqreen/kit/http_client'
+
+module Sqreen
+  module Kit
+    module Signals
+      class SignalsClient
+        STATIC_HEADERS = { 'Content-type' => 'application/json' }.freeze
+
+        # @param http_client [Sqreen::Kit:HttpClient]
+        def initialize(http_client)
+          @http_client = http_client
+        end
+
+        # @param [Array] signals_and_traces
+        # @param headers [Hash{String=>String}]
+        def report_batch(signals_and_traces, headers)
+          data = '[' + signals_and_traces.map(&:to_json).join(',') + ']'
+          @http_client.post('batches', data, STATIC_HEADERS.merge(headers))
+        end
+
+        def report_signal(signal, headers)
+          data = signal.to_json
+          @http_client.post('signals', data, STATIC_HEADERS.merge(headers))
+        end
+
+        def report_trace(trace, headers)
+          data = trace.to_json
+          @http_client.post('traces', data, STATIC_HEADERS.merge(headers))
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/kit/signals/stack_trace.rb

@@ -0,0 +1,140 @@
+# Includes code from Airbrake Technologies, Inc., under the MIT licence
+# see https://github.com/airbrake/airbrake-ruby/blob/c172657dcd4eeaf62ea23f0f7d6111be2373ea59/LICENSE.md
+
+require 'sqreen/kit/loggable'
+
+module Sqreen
+  module Kit
+    module StackTrace
+    end
+  end
+end
+
+class << Sqreen::Kit::StackTrace
+  module Patterns
+    # @return [Regexp] the pattern that matches standard Ruby stack frames,
+    #   such as ./spec/notice_spec.rb:43:in `block (3 levels) in <top (required)>'
+    RUBY = %r{\A
+            (?<file>.+)       # Matches './spec/notice_spec.rb'
+            :
+            (?<line>\d+)      # Matches '43'
+            :in\s
+            `(?<function>.*)' # Matches "`block (3 levels) in <top (required)>'"
+            \z}x
+
+    # @return [Regexp] the pattern that matches JRuby Java stack frames, such
+    #  as org.jruby.ast.NewlineNode.interpret(NewlineNode.java:105)
+    JAVA = %r{\A
+            (?<function>.+)  # Matches 'org.jruby.ast.NewlineNode.interpret'
+            \(
+            (?<file>
+              (?:uri:classloader:/.+(?=:)) # Matches '/META-INF/jruby.home/protocol.rb'
+              |
+              (?:uri_3a_classloader_3a_.+(?=:)) # Matches 'uri_3a_classloader_3a_/gems/...'
+              |
+              [^:]+        # Matches 'NewlineNode.java'
+            )
+            :?
+            (?<line>\d+)?  # Matches '105'
+            \)
+            \z}x
+
+    # @return [Regexp] the pattern that tries to assume what a generic stack
+    #   frame might look like, when exception's backtrace is set manually.
+    GENERIC = %r{\A
+              (?:from\s)?
+              (?<file>.+)              # Matches '/foo/bar/baz.ext'
+              :
+              (?<line>\d+)?            # Matches '43' or nothing
+              (?:
+                in\s`(?<function>.+)'  # Matches "in `func'"
+                |
+                :in\s(?<function>.+)   # Matches ":in func"
+              )?                       # ... or nothing
+              \z}x
+  end
+
+  include Sqreen::Kit::Loggable
+
+  # Parses an exception's backtrace.
+  #
+  # @param exception [Exception] The exception, which contains a backtrace to
+  #   parse
+  # @return [Array<Hash{Symbol=>String,Integer}>] the parsed backtrace
+  def parse(exception)
+    return [] if exception.backtrace.nil? || exception.backtrace.none?
+    do_parse(exception)
+  end
+
+  def parse_backtrace(backtrace)
+    # assume normal ruby backtrace
+    backtrace.map do |stackframe|
+      stack_frame(Patterns::RUBY, stackframe)
+    end
+  end
+
+  private
+
+  def do_parse(exception)
+    regexp = best_regexp_for(exception)
+
+    exception.backtrace.map do |stackframe|
+      stack_frame(regexp, stackframe)
+    end
+  end
+
+  def best_regexp_for(exception)
+    if java_exception?(exception)
+      Patterns::JAVA
+    else
+      Patterns::RUBY
+    end
+  end
+
+  # Checks whether the given exception was generated by JRuby's VM.
+  #
+  # @param [Exception] exception
+  # @return [Boolean]
+  def java_exception?(exception)
+    if defined?(Java::JavaLang::Throwable) &&
+       exception.is_a?(Java::JavaLang::Throwable)
+      return true
+    end
+
+    return false unless exception.respond_to?(:backtrace)
+
+    (Patterns::JAVA =~ exception.backtrace.first) != nil
+  end
+
+  def stack_frame(regexp, stackframe)
+    if (match = match_frame(regexp, stackframe))
+      return {
+        in_app: sqreen_code?(match[:file]),
+        abs_path: match[:file],
+        function: match[:function],
+        lineno: (Integer(match[:line]) if match[:line]),
+      }
+    end
+
+    logger.error(
+      "can't parse '#{stackframe}' (please file an issue so we can fix " \
+          'it: https://github.com/sqreen/ruby-sdk/issues/new)',
+    )
+    {
+      in_app: false,
+      function: stackframe,
+    }
+  end
+
+  def sqreen_code?(abs_path)
+    # Ruby uses / on Windows too
+    abs_path.include?('/lib/sqreen/')
+  end
+
+  def match_frame(regexp, stackframe)
+    match = regexp.match(stackframe)
+    return match if match
+
+    Patterns::GENERIC.match(stackframe)
+  end
+end

data/lib/sqreen/kit/signals/trace.rb

@@ -0,0 +1,34 @@
+require 'sqreen/kit/signals/dto_helper'
+require 'sqreen/kit/signals/signal'
+require 'sqreen/kit/signals/signal_attributes'
+
+# reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/trace.cue
+
+module Sqreen
+  module Kit
+    module Signals
+      class Trace
+        include SignalAttributes
+
+        def self.attributes_for_to_h_self
+          [] # we handle data ourselves
+        end
+
+        add_mandatory_attrs :data
+
+        # @return [Array<Signal>]
+        attr_accessor :data
+
+        def type
+          'trace'
+        end
+
+        def to_h
+          super.merge({
+                        data: data.map(&:to_h),
+                      })
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/kit/string_sanitizer.rb

@@ -0,0 +1,46 @@
+module Sqreen
+  module Kit
+    module StringSanitizer
+      class << self
+        def sanitize(obj)
+          case obj
+          when String
+            sanitize_string(obj)
+          when Array
+            obj.map { |e| sanitize(e) }
+          when Hash
+            obj.each_with_object({}) { |(k, v), h| h[sanitize(k)] = sanitize(v) }
+          else
+            obj
+          end
+        end
+
+        private
+
+        def sanitize_string_new(s)
+          return s if s.encoding == Encoding::UTF_8 && s.valid_encoding?
+
+          s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+        end
+
+        def sanitize_string_old(s)
+          return s if s.encoding == Encoding::UTF_8 && s.valid_encoding?
+
+          s.encode('utf-16be', invalid: :replace, undef: :replace)
+           .encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+        end
+
+        repl_ok = "\x80".dup.force_encoding(Encoding::UTF_8)
+                        .encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+                        .valid_encoding?
+        if repl_ok
+          alias_method :sanitize_string, :sanitize_string_new
+        else
+          # for Ruby < 2
+          alias_method :sanitize_string, :sanitize_string_old
+        end
+        public :sanitize_string
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sqreen-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Loic Nageleisen
+- Gustavo Lopes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqreen-backport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- lib/sqreen-kit.rb
+- lib/sqreen.rb
+- lib/sqreen/kit.rb
+- lib/sqreen/kit/configuration.rb
+- lib/sqreen/kit/http_client.rb
+- lib/sqreen/kit/http_client/authentication_error.rb
+- lib/sqreen/kit/http_client/unexpected_status_error.rb
+- lib/sqreen/kit/loggable.rb
+- lib/sqreen/kit/retry_policy.rb
+- lib/sqreen/kit/signals/actor.rb
+- lib/sqreen/kit/signals/auth_signals_client.rb
+- lib/sqreen/kit/signals/batch_collector.rb
+- lib/sqreen/kit/signals/context/http_context.rb
+- lib/sqreen/kit/signals/dto_helper.rb
+- lib/sqreen/kit/signals/metric.rb
+- lib/sqreen/kit/signals/point.rb
+- lib/sqreen/kit/signals/signal.rb
+- lib/sqreen/kit/signals/signal_attributes.rb
+- lib/sqreen/kit/signals/signals_client.rb
+- lib/sqreen/kit/signals/stack_trace.rb
+- lib/sqreen/kit/signals/trace.rb
+- lib/sqreen/kit/string_sanitizer.rb
+homepage: https://sqreen.com
+licenses:
+- Sqreen
+metadata:
+  source_code_uri: https://github.com/sqreen/ruby-sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sqreen development kit for Ruby
+test_files: []