ntl-raygun_client 0.5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 143aaa9c05da3e2f365d2f179b79e475dd967e5bf34ed633c10044011a1647f6
+  data.tar.gz: 4339ee7260be75a35c6b73607820514e884db0247caecd7a93402b4804fe9fa6
+SHA512:
+  metadata.gz: 30f1ac230de5b055707589084d6bdc4e9f3fb2e93844b7e711f9a7d7584103a91703e3da344ba11dba77036c8a69f6316f15f61cbb93d6c8fa8d4da9f8aa44f8
+  data.tar.gz: 1d42c2469948e2e64b2a19ec327f4a1908042e5c0805db856230e6b5c29f390d5d50aa07ab29ab00ec7a758e79499b90334041bde77ee54d43e34cff202ea255

data/lib/raygun_client.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'net/http'
+
+require 'configure'
+require 'error_data'
+require 'telemetry'
+require 'settings'
+
+require 'raygun_client/client_info'
+require 'raygun_client/data/client_info'
+require 'raygun_client/data'
+require 'raygun_client/settings'
+require 'raygun_client/http/post'

data/lib/raygun_client/client_info.rb

@@ -0,0 +1,15 @@
+module RaygunClient
+  module ClientInfo
+    def self.name
+      'Raygun Client'
+    end
+
+    def self.version
+      '1'
+    end
+
+    def self.url
+      'https://github.com/ntl/raygun-client'
+    end
+  end
+end

data/lib/raygun_client/controls.rb

@@ -0,0 +1,11 @@
+require 'securerandom'
+require 'clock/controls'
+
+require 'error_data/controls'
+
+require 'raygun_client/controls/random'
+require 'raygun_client/controls/time'
+
+require 'raygun_client/controls/error'
+require 'raygun_client/controls/data'
+require 'raygun_client/controls/error_data'

data/lib/raygun_client/controls/data.rb

@@ -0,0 +1,127 @@
+module RaygunClient
+  module Controls
+    module Data
+      def self.example(custom_data=nil, tags=nil, time: nil)
+        custom_data ||= self.custom_data
+        tags ||= self.tags
+        time ||= self.time
+
+        data = RaygunClient::Data.build
+
+        data.occurred_time = time
+        data.machine_name = machine_name
+        data.tags = tags
+        data.custom_data = custom_data
+
+        data.client = RaygunClient::Data::ClientInfo.build
+
+        data.error = Controls::ErrorData.example
+
+        data
+      end
+
+      def self.time
+        ::Controls::Time.example
+      end
+
+      def self.machine_name
+        'some machine name'
+      end
+
+      def self.tags
+        ['some-tag']
+      end
+
+      def self.custom_data
+        { 'someKey' => 'some value' }
+      end
+
+      module JSON
+        def self.text
+          ::JSON.generate(data)
+        end
+
+        def self.data
+          reference_time = Controls::Data.time
+
+          {
+            'occurredOn' => reference_time,
+            'details' => {
+              'machineName' => Controls::Data.machine_name,
+              'client' => Client.data,
+              'error' => Error.data,
+              'tags' => Controls::Data.tags,
+              'userCustomData' => Controls::Data.custom_data
+            }
+          }
+        end
+
+        module Client
+          def self.data
+            {
+              'name' => ClientInfo.name,
+              'version' => ClientInfo.version,
+              'clientUrl' => ClientInfo.url
+            }
+          end
+        end
+
+        module Error
+          def self.data
+            error = {}
+            error['className'] = Controls::Error.class_name
+            error['message'] = Controls::Error.message
+
+            stack_trace = StackTrace.data
+
+            error['stackTrace'] = stack_trace
+
+            error
+          end
+
+          module StackTrace
+            def self.data
+              [
+                Frames::First.data,
+                Frames::Second.data,
+                Frames::Third.data
+              ]
+            end
+
+            module Frames
+              module First
+                def self.data
+                  {
+                    'fileName' => Controls::Error::Backtrace::Frames::First.filename,
+                    'lineNumber' => Controls::Error::Backtrace::Frames::First.line_number,
+                    'methodName' => Controls::Error::Backtrace::Frames::First.method_name
+                  }
+                end
+              end
+
+              module Second
+                def self.data
+                  {
+                    'fileName' => Controls::Error::Backtrace::Frames::Second.filename,
+                    'lineNumber' => Controls::Error::Backtrace::Frames::Second.line_number,
+                    'methodName' => Controls::Error::Backtrace::Frames::Second.method_name
+                  }
+                end
+              end
+
+              module Third
+                def self.data
+                  {
+                    'fileName' => Controls::Error::Backtrace::Frames::Third.filename,
+                    'lineNumber' => Controls::Error::Backtrace::Frames::Third.line_number,
+                    'methodName' => Controls::Error::Backtrace::Frames::Third.method_name
+                  }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raygun_client/controls/error.rb

@@ -0,0 +1,5 @@
+module RaygunClient
+  module Controls
+    Error = ErrorData::Controls::Error
+  end
+end

data/lib/raygun_client/controls/error_data.rb

@@ -0,0 +1,5 @@
+module RaygunClient
+  module Controls
+    ErrorData = ::ErrorData::Controls::ErrorData
+  end
+end

data/lib/raygun_client/controls/random.rb

@@ -0,0 +1,9 @@
+module RaygunClient
+  module Controls
+    module Random
+      def self.example
+        SecureRandom.hex
+      end
+    end
+  end
+end

data/lib/raygun_client/controls/time.rb

@@ -0,0 +1,5 @@
+module RaygunClient
+  module Controls
+    Time = Clock::Controls::Time
+  end
+end

data/lib/raygun_client/data.rb

@@ -0,0 +1,74 @@
+module RaygunClient
+  class Data
+    include Schema::DataStructure
+
+    attribute :occurred_time, String
+    attribute :machine_name, String
+    attribute :client, ClientInfo
+    attribute :error, ErrorData
+    attribute :tags, Array
+    attribute :custom_data, Hash
+
+    def ==(other)
+      self.class == other.class &&
+        occurred_time == other.occurred_time &&
+        machine_name == other.machine_name &&
+        client == other.client &&
+        error == other.error
+    end
+
+    def transform_write(data)
+      data[:occurred_on] = data.delete(:occurred_time)
+
+      details = {}
+      details[:machine_name] = data.delete(:machine_name)
+
+      client = data.delete(:client)
+      details[:client] = client.to_h
+
+      error = data.delete(:error)
+
+      error_data = {}
+      error_data[:class_name] = error.class_name
+      error_data[:message] = error.message
+
+      stack_trace = []
+      error.backtrace.each do |frame|
+        frame_data = {}
+        frame_data[:file_name] = frame.filename
+        frame_data[:line_number] = frame.line_number
+        frame_data[:method_name] = frame.method_name
+        stack_trace << frame_data
+      end
+
+      error_data[:stack_trace] = stack_trace
+
+      details[:error] = error_data
+
+      tags = data.delete(:tags)
+      details[:tags] = tags unless tags.empty?
+
+      custom_data = data.delete(:custom_data)
+      details[:user_custom_data] = custom_data unless custom_data.empty?
+
+      data[:details] = details
+    end
+
+    module Transform
+      def self.json
+        JSON
+      end
+
+      def self.raw_data(instance)
+        instance.attributes
+      end
+
+      module JSON
+        def self.write(raw_data)
+          formatted_data = Casing::Camel.(raw_data)
+          ::JSON.generate(formatted_data)
+        end
+      end
+    end
+  end
+end

data/lib/raygun_client/data/client_info.rb

@@ -0,0 +1,27 @@
+module RaygunClient
+  class Data
+    class ClientInfo
+      include Schema::DataStructure
+
+      attribute :name, String
+      attribute :version, String
+      attribute :client_url, String
+
+      def ==(other)
+        name == other.name &&
+          version == other.version &&
+          client_url == other.client_url
+      end
+
+      def self.build
+        instance = new
+
+        instance.name = RaygunClient::ClientInfo.name
+        instance.version = RaygunClient::ClientInfo.version
+        instance.client_url = RaygunClient::ClientInfo.url
+
+        instance
+      end
+    end
+  end
+end

data/lib/raygun_client/http/post.rb

@@ -0,0 +1,138 @@
+module RaygunClient
+  module HTTP
+    class Post
+      include Configure
+      include Dependency
+      include Settings::Setting
+
+      include ::Telemetry::Dependency
+      include Log::Dependency
+
+      setting :api_key
+
+      attr_reader :data
+
+      configure :raygun_post
+
+      def self.build(connection: nil)
+        instance = new
+        RaygunClient::Settings.set(instance)
+        instance
+      end
+
+      def self.call(data)
+        instance = build
+        instance.(data)
+      end
+
+      def call(data)
+        logger.trace { "Posting to Raygun" }
+        json_text = Transform::Write.(data, :json)
+
+        response = http_post(json_text)
+
+        telemetry.record(:posted, Telemetry::Data.new(data, response))
+
+        logger.info { "Posted to Raygun (#{LogText::Posted.(data, response)})" }
+
+        response
+      end
+
+      def self.host
+        'api.raygun.io'
+      end
+
+      def self.path
+        '/entries'
+      end
+
+      def self.uri
+        @uri ||= URI::HTTPS.build(:host => host, :path => path)
+      end
+
+      def http_post(request_body)
+        uri = self.class.uri
+
+        response = Net::HTTP.post(uri, request_body, { 'X-ApiKey' => api_key })
+
+        response
+      end
+
+      def self.register_telemetry_sink(post)
+        sink = Telemetry.sink
+        post.telemetry.register(sink)
+        sink
+      end
+
+      module Telemetry
+        class Sink
+          include ::Telemetry::Sink
+
+          record :posted
+
+          def posts(&blk)
+            if blk.nil?
+              return posted_records
+            end
+
+            posted_records.select do |record|
+              blk.call(record.data.data, record.data.response)
+            end
+          end
+
+          def posted?(&blk)
+            if blk.nil?
+              return recorded_posted?
+            end
+
+            recorded_posted? do |record|
+              blk.call(record.data.data, record.data.response)
+            end
+          end
+        end
+
+        Data = Struct.new(:data, :response)
+
+        def self.sink
+          Sink.new
+        end
+      end
+
+      module Substitute
+        def self.build
+          substitute = Substitute::Post.new
+
+          sink = RaygunClient::HTTP::Post.register_telemetry_sink(substitute)
+          substitute.sink = sink
+
+          substitute
+        end
+
+        class Post < HTTP::Post
+          attr_accessor :sink
+
+          def http_post(_)
+          end
+
+          def posted?(data=nil, &block)
+            unless data.nil?
+              block ||= proc { |posted_data|
+                data == posted_data
+              }
+            end
+
+            sink.posted?(&block)
+          end
+        end
+      end
+
+      module LogText
+        module Posted
+          def self.call(data, response)
+            "Status Code: #{response&.code || '(none)'}, Reason Phrase: #{response&.message || '(none)'}, Error Message: #{data.error.message}, Custom Data: #{data.custom_data || '(none)'})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raygun_client/settings.rb

@@ -0,0 +1,15 @@
+module RaygunClient
+  class Settings < ::Settings
+    def self.instance
+      @instance ||= build
+    end
+
+    def self.data_source
+      'settings/raygun_client.json'
+    end
+
+    def self.set(receiver)
+      instance.set(receiver)
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: ntl-raygun_client
+version: !ruby/object:Gem::Version
+  version: 0.5.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-configure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-telemetry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ntl-error_data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/raygun_client.rb
+- lib/raygun_client/client_info.rb
+- lib/raygun_client/controls.rb
+- lib/raygun_client/controls/data.rb
+- lib/raygun_client/controls/error.rb
+- lib/raygun_client/controls/error_data.rb
+- lib/raygun_client/controls/random.rb
+- lib/raygun_client/controls/time.rb
+- lib/raygun_client/data.rb
+- lib/raygun_client/data/client_info.rb
+- lib/raygun_client/http/post.rb
+- lib/raygun_client/settings.rb
+homepage: https://github.com/ntl/raygun-client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key:
+specification_version: 4
+summary: Client for the Raygun API
+test_files: []