informant-rails 1.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c1e2831661a181fd46873e1a67eea335e84ffab1
-  data.tar.gz: 0e6f326c3373eb8716be5b09ec006dcc0a0fcce2
+SHA256:
+  metadata.gz: 854e3ae4ab00261622e7c1a2f6fbd95e9ecc89057d1e3027fd6d8ae9187f7591
+  data.tar.gz: 5ac12d8002cc25e135c7f6f0d29e2553dade24b21b6fd1cab6511517cb0d8641
 SHA512:
-  metadata.gz: 0cabe2ffa1e527c286924329ae3c11740cbdeb9445a0698205c5c05157184cadff6c1c97d80b7ce6490790875f905b25f78550494b2a53974eda8946dbce9c59
-  data.tar.gz: c4f0308b365db3ddded71bc6263a2d077038fc3c34ef843aff54d438746c8f36568b9a77963d30fc1d15e0c306c4af8d96d043b0d035a8643a4f1ab70f0c759e
+  metadata.gz: 811722c69c8a0855460077e19d07a3bfe2a42738115e127e98b556255d83aa69c099d75d51b904e5224aa06a3a441dde71372f49bd14143d20057717c7c35015
+  data.tar.gz: 923c1ee5338b25d9c97bfd84f368c6ce3efe5719c57973b324a73f2ba631c949a5795a37cf5b60f3a62c0606918c4f835d45298b9cb37bce4c100b287709f0f8

data/README.markdown

@@ -8,12 +8,11 @@ The informant-rails gem provides Rails and ActiveRecord hooks for The Informant.
 
 ## Compatibility
 
-The informant-rails gem officially supports Ruby 2.0+.
+The informant-rails gem officially supports Ruby 2.5+.
 
-It will work automatically with Rails 3 and up as well as Mongoid 3 and up.
+It will work automatically with Rails 5.2+ as well as Mongoid 6.2 and up.
 
-[![Build Status](https://travis-ci.org/informantapp/informant-rails.svg?branch=master)](https://travis-ci.org/informantapp/informant-rails)
-[![Code Climate](https://codeclimate.com/github/informantapp/informant-rails.png)](https://codeclimate.com/github/informantapp/informant-rails)
+[![pipeline status](https://gitlab.com/informantapp/informant-rails/badges/master/pipeline.svg)](https://gitlab.com/informantapp/informant-rails/-/commits/master)
 
 ## Installation
 
@@ -28,6 +27,10 @@ It will work automatically with Rails 3 and up as well as Mongoid 3 and up.
 4. Deploy with the gem installed
 5. Submit a form and you'll see it appear in our web interface
 
+We've set up
+[informant-rails-example](https://gitlab.com/informantapp/informant-rails-example)
+as a demonstrate of installation and operation.
+
 ## Usage
 
 By default, any request that causes an ActiveRecord or Mongoid model to be validated will be tracked by the Informant once the gem is added to your project.

data/Rakefile

@@ -1,12 +1,15 @@
-require "bundler/setup"
-require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  require "appraisal/task"
-  Appraisal::Task.new
-  task default: :appraisal
-else
-  require "rspec/core/rake_task"
+default_task = :spec
+
+if ENV['APPRAISAL_INITIALIZED']
+  require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new
-  task default: :spec
+else
+  require 'appraisal/task'
+  Appraisal::Task.new
+  default_task = :appraisal
 end
+
+task default: default_task

data/lib/informant-rails/config.rb

@@ -1,24 +1,13 @@
-module InformantRails::Config
-  extend self
-
-  attr_accessor :api_token, :exclude_models, :filter_parameters, :value_tracking
-
-  self.api_token
-  self.exclude_models = []
-  self.filter_parameters = []
-  self.value_tracking = true
-
-  def configure; yield self end
-
-  def self.client_identifier
-    @client_identifier ||= "informant-rails-#{InformantRails::VERSION}"
-  end
-
-  def self.enabled?
-    api_token.present?
-  end
-
-  def self.collector_host
-    @collector_host ||= ENV['INFORMANT_COLLECTOR_HOST'] || 'https://collector-api.informantapp.com'
+module InformantRails
+  module Config
+    extend self
+
+    delegate :api_token, :api_token=,
+             :collector_host,
+             :enabled?,
+             :exclude_models, :exclude_models=,
+             :filter_parameters, :filter_parameters=,
+             :value_tracking?, :value_tracking=,
+             to: InformantCommon::Config
   end
 end

data/lib/informant-rails/{connection_tester.rb → diagnostic.rb}

@@ -1,24 +1,23 @@
+class TestClass
+  include ActiveModel::Model
+
+  attr_accessor :field_name
+
+  validates_presence_of :field_name
+end
+
 module InformantRails
-  class ConnectionTester
-    def self.run; new.run end
+  class Diagnostic
+    def self.run
+      new.run
+    end
 
     def run
       if Config.api_token.blank?
         Rails.logger.info missing_api_token_message
       else
-        Client.record('HTTP_REFERER' => '/connectivity/test')
-        Client.record_action('Connectivity', 'test')
-        Client.request.instance_variable_set('@models', [{
-          name: 'TestClass',
-          errors: [name: 'field_name', value: 'field_value', message: 'must be unique']
-        }])
-        response = Client.transmit(Client.request)
-
-        if response.success?
-          Rails.logger.info success_message
-        else
-          Rails.logger.info bad_response_message(response.body)
-        end
+        response = InformantCommon::Client.transmit(test_form_submission).join.value
+        display_response_message(response)
       end
 
       Rails.logger.info assistance_message
@@ -44,11 +43,26 @@ module InformantRails
     end
 
     def success_message
-      "Everything looks good. You should see a test request on your dashboard."
+      'Everything looks good. You should see a test request on your dashboard.'
     end
 
     def assistance_message
       "If you need assistance or have any questions, send an email to support@informantapp.com or tweet @informantapp and we'll help you out!"
     end
+
+    def test_form_submission
+      InformantCommon::Event::FormSubmission.new.tap do |form_submission|
+        form_submission.handler = 'Connectivity#test'
+        form_submission.process_model(InformantCommon::Model::ActiveModel.new(TestClass.new.tap(&:valid?)))
+      end
+    end
+
+    def display_response_message(response)
+      if response.code == '204'
+        Rails.logger.info success_message
+      else
+        Rails.logger.info bad_response_message(response.body)
+      end
+    end
   end
 end

data/lib/informant-rails/middleware.rb

@@ -1,9 +1,13 @@
 module InformantRails
-  class Middleware < Struct.new(:app)
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
     def call(env)
-      Client.record(env)
-      response = app.call(env)
-      Client.process
+      InformantCommon::Client.start_transaction!(env['REQUEST_METHOD'])
+      response = @app.call(env)
+      InformantCommon::Client.process
       response
     end
   end

data/lib/informant-rails/railtie.rb

@@ -1,13 +1,17 @@
 module InformantRails
   class Railtie < ::Rails::Railtie
     initializer 'informant' do |config|
-      Config.api_token ||= ENV['INFORMANT_API_KEY']
-
       if Config.enabled?
-        config.middleware.use InformantRails::Middleware
-
+        InformantCommon::Client.transmit(
+          InformantCommon::Event::AgentInfo.new(
+            agent_identifier: "informant-rails-#{InformantRails::VERSION}",
+            framework_version: "rails-#{Rails.version}"
+          )
+        )
         InformantRails::Config.filter_parameters = Rails.configuration.filter_parameters
 
+        config.middleware.use InformantRails::Middleware
+
         ActiveSupport.on_load(:action_controller) do
           include InformantRails::RequestTracking
         end
@@ -20,6 +24,8 @@ module InformantRails
           include InformantRails::ValidationTracking
         end
       end
+    rescue StandardError => e
+      puts "Unable to bootstrap informant: #{e.message}"
     end
   end
 end

data/lib/informant-rails/request_tracking.rb

@@ -5,11 +5,11 @@ module InformantRails
     included do
       if defined? before_action
         before_action do
-          InformantRails::Client.record_action(controller_name, action_name)
+          InformantCommon::Client.current_transaction&.handler = [controller_name, action_name].join('#')
         end
       else
         before_filter do
-          InformantRails::Client.record_action(controller_name, action_name)
+          InformantCommon::Client.current_transaction&.handler = [controller_name, action_name].join('#')
         end
       end
     end

data/lib/informant-rails/validation_tracking.rb

@@ -3,9 +3,7 @@ module InformantRails
     extend ActiveSupport::Concern
 
     included do
-      set_callback(:validate, :after) do
-        InformantRails::Client.record_validated_model(self)
-      end
+      include InformantCommon::ValidationTracking
     end
   end
 end

data/lib/informant-rails/version.rb

@@ -1,3 +1,3 @@
 module InformantRails
-  VERSION = '1.1.0'
+  VERSION = '2.3.0'.freeze
 end

data/lib/informant-rails.rb

@@ -3,15 +3,12 @@ if defined?(Rake)
   Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
 end
 
+require 'informant-common'
+
 module InformantRails
   autoload :Config,             'informant-rails/config'
-  autoload :ConnectionTester,   'informant-rails/connection_tester'
-  autoload :Client,             'informant-rails/client'
-  autoload :FieldError,         'informant-rails/field_error'
+  autoload :Diagnostic,         'informant-rails/diagnostic'
   autoload :Middleware,         'informant-rails/middleware'
-  autoload :Model,              'informant-rails/model'
-  autoload :Request,            'informant-rails/request'
-  autoload :ParameterFilter,    'informant-rails/parameter_filter'
   autoload :RequestTracking,    'informant-rails/request_tracking'
   autoload :ValidationTracking, 'informant-rails/validation_tracking'
   autoload :VERSION,            'informant-rails/version'

data/lib/tasks/diagnostic.rake

@@ -0,0 +1,7 @@
+namespace :informant do
+  desc 'Verify connectivity from your app to Informant'
+  task diagnostic: :environment do
+    Rails.logger = Logger.new($stdout)
+    InformantRails::Diagnostic.run
+  end
+end

metadata

@@ -1,29 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: informant-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Informant, LLC
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: informant-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: The Informant tracks what users do wrong in your forms so you can make
   them better.
 email:
@@ -36,24 +70,20 @@ files:
 - README.markdown
 - Rakefile
 - lib/informant-rails.rb
-- lib/informant-rails/client.rb
 - lib/informant-rails/config.rb
-- lib/informant-rails/connection_tester.rb
-- lib/informant-rails/field_error.rb
+- lib/informant-rails/diagnostic.rb
 - lib/informant-rails/middleware.rb
-- lib/informant-rails/model.rb
-- lib/informant-rails/parameter_filter.rb
 - lib/informant-rails/railtie.rb
-- lib/informant-rails/request.rb
 - lib/informant-rails/request_tracking.rb
 - lib/informant-rails/validation_tracking.rb
 - lib/informant-rails/version.rb
-- lib/tasks/test_connection.rake
+- lib/tasks/diagnostic.rake
 homepage: https://www.informantapp.com
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,16 +91,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: The Informant tracks server-side validation errors and gives you metrics
   you never dreamed of.

data/lib/informant-rails/client.rb

@@ -1,66 +0,0 @@
-require 'net/http'
-
-module InformantRails
-  class Client
-
-    def self.record(env)
-      new_request.request_url = env['HTTP_REFERER'] unless env['REQUEST_METHOD'] == 'GET'
-    end
-
-    def self.record_action(controller_name, action)
-      if request
-        request.filename = controller_name
-        request.action = action
-      end
-    end
-
-    def self.record_validated_model(model)
-      request.process_model(model) if request && include_model?(model)
-    end
-
-    def self.process
-      if request && request.models.any?
-        this_request = request
-        Thread.new { transmit(this_request) }
-      end
-    ensure
-      cleanup
-    end
-
-    def self.request
-      Thread.current[:informant_request]
-    end
-
-    def self.cleanup
-      Thread.current[:informant_request] = nil
-    end
-
-    def self.transmit(completed_request)
-      Net::HTTP.start(api_endpoint.host, api_endpoint.port, use_ssl: api_endpoint.scheme == 'https') do |http|
-        http.request(net_http_post_request(completed_request))
-      end
-    end
-
-    private
-
-    def self.net_http_post_request(completed_request)
-      Net::HTTP::Post.new(api_endpoint, {
-        "Authorization" => ActionController::HttpAuthentication::Token.encode_credentials(Config.api_token),
-        "Content-Type" => "application/json"
-      }).tap { |r| r.body = { payload: completed_request }.to_json }
-    end
-
-    def self.include_model?(model)
-      !Config.exclude_models.include?(model.class.to_s)
-    end
-
-    def self.new_request
-      Thread.current[:informant_request] = Request.new
-    end
-
-    def self.api_endpoint
-      @api_endpoint ||= URI("#{Config.collector_host}/api/v1/form_submissions")
-    end
-
-  end
-end

data/lib/informant-rails/field_error.rb

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

data/lib/informant-rails/model.rb

@@ -1,17 +0,0 @@
-module InformantRails
-  class Model < Struct.new(:model)
-    def name
-      model.class.name
-    end
-
-    def errors
-      model.errors.map do |field, error|
-        InformantRails::FieldError.new(field.to_s, model[field], error)
-      end
-    end
-
-    def as_json(*args)
-      { name: name, errors: errors.map(&:as_json) }
-    end
-  end
-end

data/lib/informant-rails/parameter_filter.rb

@@ -1,13 +0,0 @@
-module InformantRails
-  class ParameterFilter
-    def self.filter(name, value)
-      Config.value_tracking && !matcher.match(name) ? value : '[FILTERED]'
-    end
-
-    protected
-
-    def self.matcher
-      @matcher ||= Regexp.new(/#{Config.filter_parameters.join('|').presence || '$^'}/)
-    end
-  end
-end

data/lib/informant-rails/request.rb

@@ -1,36 +0,0 @@
-module InformantRails
-  class Request
-    attr_accessor :request_url, :filename, :action
-
-    def process_model(model)
-      if model && untracked?(model)
-        models << InformantRails::Model.new(model)
-      end
-    end
-
-    def models
-      @models ||= []
-    end
-
-    def as_json(*args)
-      {
-        models: models.map(&:as_json),
-        request_url: request_url,
-        filename: filename,
-        action: action,
-        client: InformantRails::Config.client_identifier,
-        rails_version: rails_version
-      }
-    end
-
-    protected
-
-    def rails_version
-      @rails_version ||= Rails.version
-    end
-
-    def untracked?(model)
-      !models.detect { |container| container.model == model }
-    end
-  end
-end

data/lib/tasks/test_connection.rake

@@ -1,8 +0,0 @@
-namespace :informant do
-
-  desc "Sends a sample request from your server to Informant"
-  task :test_connection => :environment do
-    InformantRails::ConnectionTester.run
-  end
-
-end