informant-rails 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cbcd0c5777f13bb8349e55a5ce8fcb632a9440e2e74b3d689caa42a827dcd7'
-  data.tar.gz: 271fbd0dbfb43bfd7b77b3baa557838b6edd00c8c14bfd1086e66e018ff9dccf
+  metadata.gz: 69200fabf6b1767d2cb6a26d3a9c46e7c3c8fdb1d3d08a3ad9b63a919a0bc8c8
+  data.tar.gz: dbd81e0ed5e7c86ea0afa48a7bd0587d55b2f647ec896a09534e6571a25eee70
 SHA512:
-  metadata.gz: b4c230402306aedf9f97ac782ed3326d422a6af5ba616555c99f0daa4e6a102cce4b97ac63c0410a3581e651253e4f75b635cf6ace522626cb5ada7aeab64441
-  data.tar.gz: 607df63cd48e566a382040bb5953a3e194536ce5a8f3dfc6f72e4b51b09e8713fb748710eb6c82f311e960c1cddaf9978956fb8b36c99e0d42ef3c8da83bb970
+  metadata.gz: c9220c0cfc3ddb9d4a5845851b31b50d2d6d6b53963ae9cb2b657c15fd179cb67a506c0e9a4b8ac77fb209e5c7945ecac06e930df40af7aeb714a0a018226bf9
+  data.tar.gz: 2746d2d97cae5c6fc47b67fe223e9bf097d08f72de1c1ac06cfa3bd14bcb0773be649b3d63b2eb061619d8a19ade22c1348c32be7c3f0626cbebb0320eab75b9

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,12 @@
-require "bundler/setup"
-require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  require "appraisal/task"
+if !ENV['APPRAISAL_INITIALIZED']
+  require 'appraisal/task'
   Appraisal::Task.new
   task default: :appraisal
 else
-  require "rspec/core/rake_task"
+  require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new
   task default: :spec
 end

data/lib/informant-rails.rb

@@ -3,23 +3,15 @@ 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 :Diagnostic,         'informant-rails/diagnostic'
-  autoload :Client,             'informant-rails/client'
-  autoload :FieldError,         'informant-rails/field_error'
   autoload :Middleware,         'informant-rails/middleware'
-  autoload :Model,              'informant-rails/model'
-  autoload :ParameterFilter,    'informant-rails/parameter_filter'
   autoload :RequestTracking,    'informant-rails/request_tracking'
   autoload :ValidationTracking, 'informant-rails/validation_tracking'
   autoload :VERSION,            'informant-rails/version'
-
-  module Event
-    autoload :Base,             'informant-rails/event/base'
-    autoload :ClientInfo,       'informant-rails/event/client_info'
-    autoload :FormSubmission,   'informant-rails/event/form_submission'
-  end
 end
 
 require 'informant-rails/railtie'

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/diagnostic.rb

@@ -1,34 +1,23 @@
 class TestClass
-  def errors
-    {
-      field_name: 'must be unique'
-    }
-  end
+  include ActiveModel::Model
 
-  def [](field)
-    'field_value'
-  end
+  attr_accessor :field_name
+
+  validates_presence_of :field_name
 end
 
 module InformantRails
   class Diagnostic
-    def self.run; new.run end
+    def self.run
+      new.run
+    end
 
     def run
       if Config.api_token.blank?
         Rails.logger.info missing_api_token_message
       else
-        form_submission = InformantRails::Event::FormSubmission.new
-        form_submission.filename = 'Connectivity'
-        form_submission.action = 'test'
-        form_submission.process_model(TestClass.new)
-        response = Client.transmit(form_submission).join.value
-
-        if response.code == '204'
-          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
@@ -54,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,11 +1,14 @@
 module InformantRails
   class Railtie < ::Rails::Railtie
     initializer 'informant' do |config|
-      Config.api_token ||= ENV['INFORMANT_API_KEY']
-
       begin
         if Config.enabled?
-          InformantRails::Client.log_client_info
+          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
@@ -22,8 +25,8 @@ module InformantRails
             include InformantRails::ValidationTracking
           end
         end
-      rescue
-        puts "Unable to bootstrap informant."
+      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 = '2.1.0'
+  VERSION = '2.2.0'.freeze
 end

data/lib/tasks/diagnostic.rake

@@ -1,9 +1,7 @@
 namespace :informant do
-
-  desc "Verify connectivity from your app to Informant"
-  task :diagnostic => :environment 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,22 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: informant-rails
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Informant, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2020-05-31 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.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
@@ -26,10 +40,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.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:
@@ -42,16 +70,9 @@ files:
 - README.markdown
 - Rakefile
 - lib/informant-rails.rb
-- lib/informant-rails/client.rb
 - lib/informant-rails/config.rb
 - lib/informant-rails/diagnostic.rb
-- lib/informant-rails/event/base.rb
-- lib/informant-rails/event/client_info.rb
-- lib/informant-rails/event/form_submission.rb
-- lib/informant-rails/field_error.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_tracking.rb
 - lib/informant-rails/validation_tracking.rb
@@ -76,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The Informant tracks server-side validation errors and gives you metrics

data/lib/informant-rails/client.rb

@@ -1,70 +0,0 @@
-require 'net/http'
-
-module InformantRails
-  class Client
-    def self.enabled?; @enabled end
-    def self.disable!; @enabled = false end
-    def self.enable!; @enabled = true end
-    enable!
-
-    def self.supported_request_methods
-      @supported_request_methods ||= %w(POST PATCH PUT DELETE)
-    end
-
-    def self.record(env)
-      new_request if enabled? && supported_request_methods.include?(env['REQUEST_METHOD'])
-    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
-        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(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
-
-    def self.log_client_info
-      transmit(InformantRails::Event::ClientInfo.new)
-    end
-
-    private
-
-    def self.include_model?(model)
-      !Config.exclude_models.include?(model.class.to_s)
-    end
-
-    def self.new_request
-      Thread.current[:informant_request] = Event::FormSubmission.new
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-module InformantRails::Event
-  class Base
-    def self.endpoint
-      raise 'Must implement'
-    end
-    def endpoint; self.class.endpoint end
-
-    def self.authorization_header_value
-      @authorization_header_value ||= ActionController::HttpAuthentication::Token.encode_credentials(InformantRails::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

data/lib/informant-rails/event/client_info.rb

@@ -1,16 +0,0 @@
-module InformantRails::Event
-  class ClientInfo < Base
-    def as_json(*args)
-      {
-        agent_identifier: InformantRails::Config.client_identifier,
-        framework_version: "rails-#{Rails.version}",
-        runtime_version: "ruby-#{RUBY_VERSION}",
-        mongoid_version: defined?(Mongoid) ? Mongoid::VERSION : nil
-      }
-    end
-
-    def self.endpoint
-      @endpoint ||= URI("#{InformantRails::Config.collector_host}/v2/client-info")
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-module InformantRails::Event
-  class FormSubmission < Base
-    attr_accessor :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)
-      {
-        name: [filename, action].compact.join('#'),
-        models: models.map(&:as_json)
-      }
-    end
-
-    def self.endpoint
-      @endpoint ||= URI("#{InformantRails::Config.collector_host}/v2/form-submissions")
-    end
-
-    protected
-
-    def rails_version
-      @rails_version ||= Rails.version
-    end
-
-    def untracked?(model)
-      !models.detect { |container| container.model == model }
-    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