informant-common 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a0530b6e7f368bf9813089d13ae91e6efea52bb86e0aab43b28642988a8ec21
+  data.tar.gz: 8e485234656bb89473bdbf7d4ae3d5a25652dc2d86440c96f4f801ce4bc8e5ef
+SHA512:
+  metadata.gz: b9c4e2eea975a321d588311fb80fa663e409d787fd5c44bef40ba5e8bceff28ae0c9e0219754410979a08122323d4544b1fb2b3c05a870809c25fb94ab18f38c
+  data.tar.gz: 349acd7e71ae351263323dcb7da547ccf8614d338df22466a3d583f98c831eefead70815ac5b226446b02d1cd66190c822aa16ef13e07820908d2fa428e94064

data/LICENSE

@@ -0,0 +1,8 @@
+MIT License
+Copyright (c) 2016 Informant, LLC
+
+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.

data/README.markdown

@@ -0,0 +1,16 @@
+# Overview
+
+## Informant Common
+
+The informant-common gem provides underlying common functionality for building
+a framework-specific client in Ruby.
+
+Please see [informant-rails](https://gitlab.com/informantapp/informant-rails) for the official Ruby on Rails client.
+
+[![Homepage](https://s3.amazonaws.com/assets.heroku.com/addons.heroku.com/icons/1347/original.png)](https://www.informantapp.com)
+
+## Compatibility
+
+The Informant officially supports Ruby 2.5+.
+
+[![pipeline status](https://gitlab.com/informantapp/informant-common/badges/master/pipeline.svg)](https://gitlab.com/informantapp/informant-common/-/commits/master)

data/Rakefile

@@ -0,0 +1,9 @@
+if !ENV['APPRAISAL_INITIALIZED']
+  require 'appraisal/task'
+  Appraisal::Task.new
+  task default: :appraisal
+else
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+  task default: :spec
+end

data/lib/informant-common.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+
+if defined?(Rake)
+  require 'rake'
+  Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+end
+
+module InformantCommon
+  autoload :Client,             'informant-common/client'
+  autoload :Config,             'informant-common/config'
+  autoload :FieldError,         'informant-common/field_error'
+  autoload :ParameterFilter,    'informant-common/parameter_filter'
+  autoload :ValidationTracking, 'informant-common/validation_tracking'
+
+  module Model
+    autoload :ActiveModel, 'informant-common/model/active_model'
+    autoload :Base,        'informant-common/model/base'
+  end
+
+  module Event
+    autoload :Base,               'informant-common/event/base'
+    autoload :AgentInfo,          'informant-common/event/agent_info'
+    autoload :FormSubmission,     'informant-common/event/form_submission'
+    autoload :MockFormSubmission, 'informant-common/event/mock_form_submission'
+  end
+end

data/lib/informant-common/client.rb

@@ -0,0 +1,53 @@
+module InformantCommon
+  class Client
+    SUPPORTED_REQUEST_METHODS = %w[POST PATCH PUT DELETE].freeze
+
+    def self.enabled?
+      @enabled
+    end
+
+    def self.disable!
+      @enabled = false
+    end
+
+    def self.enable!
+      @enabled = true
+    end
+    enable!
+
+    def self.start_transaction!(request_method)
+      if enabled? && SUPPORTED_REQUEST_METHODS.include?(request_method)
+        Thread.current[:informant_transaction] = InformantCommon::Event::FormSubmission.new
+      else
+        reset_transaction!
+      end
+    end
+
+    def self.current_transaction
+      Thread.current[:informant_transaction] ||= InformantCommon::Event::MockFormSubmission.new
+    end
+
+    def self.reset_transaction!
+      Thread.current[:informant_transaction] = nil
+    end
+
+    def self.process
+      if current_transaction.valid?
+        this_transaction = current_transaction
+        transmit(this_transaction)
+      end
+    ensure
+      reset_transaction!
+    end
+
+    def self.transmit(event)
+      Thread.new(Client) do |client_class|
+        Net::HTTP.start(*event.net_http_start_arguments) do |http|
+          response = http.request(event.post_request)
+          client_class.disable! if response.code == '401'
+          response
+        end
+      end
+    end
+  end
+end

data/lib/informant-common/config.rb

@@ -0,0 +1,62 @@
+module InformantCommon
+  class Config
+    def self.instance
+      @instance ||= InformantCommon::Config.new
+    end
+
+    attr_accessor :api_token
+
+    attr_writer :client_identifier
+    def client_identifier
+      @client_identifier ||= "informant-common-#{InformantCommon::VERSION}"
+    end
+    alias agent_identifier client_identifier
+
+    def enabled?
+      !api_token.nil? && api_token != ''
+    end
+
+    attr_writer :exclude_models
+    def exclude_models
+      @exclude_models ||= []
+    end
+
+    attr_writer :filter_parameters
+    def filter_parameters
+      @filter_parameters ||= []
+    end
+
+    attr_writer :value_tracking
+    def value_tracking?
+      if !defined?(@value_tracking)
+        @value_tracking = true
+      else
+        @value_tracking
+      end
+    end
+
+    def self.collector_host
+      @collector_host ||= ENV['INFORMANT_COLLECTOR_HOST'] || 'https://collector-api.informantapp.com'
+    end
+
+    def self.configure
+      yield instance
+    end
+
+    def self.method_missing(name, *args)
+      if instance.respond_to?(name)
+        instance.public_send(name, *args)
+      else
+        super
+      end
+    end
+
+    def self.respond_to_missing?(name)
+      instance.respond_to?(name)
+    end
+
+    def self.reset!
+      @instance = nil
+    end
+  end
+end

data/lib/informant-common/event/agent_info.rb

@@ -0,0 +1,25 @@
+module InformantCommon
+  module Event
+    class AgentInfo < InformantCommon::Event::Base
+      attr_accessor :agent_identifier, :framework_version
+
+      def initialize(agent_identifier: InformantCommon::Config.client_identifier, framework_version: nil)
+        self.agent_identifier = agent_identifier
+        self.framework_version = framework_version
+      end
+
+      def as_json(*_args)
+        {
+          agent_identifier: agent_identifier || InformantCommon::Config.client_identifier,
+          framework_version: framework_version,
+          runtime_version: "ruby-#{RUBY_VERSION}",
+          mongoid_version: defined?(Mongoid) ? Mongoid::VERSION : nil
+        }
+      end
+
+      def self.endpoint
+        @endpoint ||= URI("#{InformantCommon::Config.collector_host}/v2/client-info")
+      end
+    end
+  end
+end

data/lib/informant-common/event/base.rb

@@ -0,0 +1,35 @@
+module InformantCommon
+  module Event
+    class Base
+      def self.endpoint
+        raise 'Must implement'
+      end
+
+      def endpoint
+        self.class.endpoint
+      end
+
+      def self.authorization_header_value
+        @authorization_header_value ||= "Token token=\"#{InformantCommon::Config.api_token}\""
+      end
+
+      def authorization_header_value
+        self.class.authorization_header_value
+      end
+
+      def post_request
+        Net::HTTP::Post.new(endpoint,
+                            'Authorization' => authorization_header_value,
+                            'Content-Type' => 'application/json').tap { |r| r.body = to_json }
+      end
+
+      def self.net_http_start_arguments
+        @net_http_start_arguments ||= [endpoint.host, endpoint.port, use_ssl: endpoint.scheme == 'https']
+      end
+
+      def net_http_start_arguments
+        self.class.net_http_start_arguments
+      end
+    end
+  end
+end

data/lib/informant-common/event/form_submission.rb

@@ -0,0 +1,37 @@
+module InformantCommon
+  module Event
+    class FormSubmission < InformantCommon::Event::Base
+      attr_accessor :handler
+
+      def process_model(model)
+        return if model.nil? || Config.exclude_models.include?(model.name)
+
+        models.reject! { |container| container.id == model.id }
+        models << model
+      end
+
+      def models
+        @models ||= []
+      end
+
+      def valid?
+        models.any?
+      end
+
+      def as_json(*_args)
+        {
+          name: handler,
+          models: models.map(&:as_json)
+        }
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def self.endpoint
+        @endpoint ||= URI("#{InformantCommon::Config.collector_host}/v2/form-submissions")
+      end
+    end
+  end
+end

data/lib/informant-common/event/mock_form_submission.rb

@@ -0,0 +1,11 @@
+module InformantCommon
+  module Event
+    class MockFormSubmission < InformantCommon::Event::FormSubmission
+      def process_model(_model); end
+
+      def models
+        []
+      end
+    end
+  end
+end

data/lib/informant-common/field_error.rb

@@ -0,0 +1,20 @@
+module InformantCommon
+  class FieldError
+    attr_accessor :name, :message
+    attr_reader :value
+
+    def initialize(name, value, message = nil)
+      self.name = name
+      self.value = value
+      self.message = message
+    end
+
+    def value=(value)
+      @value = InformantCommon::ParameterFilter.filter(name, value)
+    end
+
+    def as_json(*_args)
+      { name: name, value: value, message: message }
+    end
+  end
+end

data/lib/informant-common/model/active_model.rb

@@ -0,0 +1,22 @@
+module InformantCommon
+  module Model
+    class ActiveModel < Base
+      def initialize(active_model)
+        self.id = active_model.object_id
+        self.name = active_model.class.name
+        self.errors = []
+        active_model.errors.each do |field, error|
+          add_error(field.to_s, extract_value(active_model, field), error)
+        end
+      end
+
+      private
+
+      def extract_value(active_model, field)
+        active_model.public_send(field)
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/informant-common/model/base.rb

@@ -0,0 +1,30 @@
+module InformantCommon
+  module Model
+    class Base
+      attr_accessor :id, :name
+      attr_writer :errors
+
+      def initialize(id: nil, name: nil, field_errors: [])
+        self.id = id
+        self.name = name
+        self.errors = field_errors
+      end
+
+      def errors
+        @errors ||= []
+      end
+
+      def add_error(field_name, value, message)
+        errors << FieldError.new(field_name, value, message)
+      end
+
+      def as_json(*_args)
+        { name: name, errors: errors.map(&:as_json) }
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+    end
+  end
+end

data/lib/informant-common/parameter_filter.rb

@@ -0,0 +1,21 @@
+module InformantCommon
+  class ParameterFilter
+    def self.filter(name, value)
+      Config.value_tracking? && !matcher.match(name) ? value : '[FILTERED]'
+    end
+
+    def self.matcher
+      @matcher ||= Regexp.new(
+        if Config.filter_parameters.any?
+          /#{Config.filter_parameters.join('|')}/
+        else
+          /$^/
+        end
+      )
+    end
+
+    def self.reset!
+      @matcher = nil
+    end
+  end
+end

data/lib/informant-common/validation_tracking.rb

@@ -0,0 +1,15 @@
+module InformantCommon
+  module ValidationTracking
+    if defined?(ActiveSupport)
+      extend ActiveSupport::Concern
+
+      included do
+        set_callback(:validate, :after) do
+          InformantCommon::Client.current_transaction.process_model(
+            InformantCommon::Model::ActiveModel.new(self)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/informant-common/version.rb

@@ -0,0 +1,3 @@
+module InformantCommon
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: informant-common
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Informant, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-28 00:00:00.000000000 Z
+dependencies: []
+description: This gem contains the common components for reporting data to the Informant.
+email:
+- support@informantapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/informant-common.rb
+- lib/informant-common/client.rb
+- lib/informant-common/config.rb
+- lib/informant-common/event/agent_info.rb
+- lib/informant-common/event/base.rb
+- lib/informant-common/event/form_submission.rb
+- lib/informant-common/event/mock_form_submission.rb
+- lib/informant-common/field_error.rb
+- lib/informant-common/model/active_model.rb
+- lib/informant-common/model/base.rb
+- lib/informant-common/parameter_filter.rb
+- lib/informant-common/validation_tracking.rb
+- lib/informant-common/version.rb
+homepage: https://www.informantapp.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The Informant tracks server-side validation errors and gives you metrics
+  you never dreamed of.
+test_files: []