informant-rails 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c1e2831661a181fd46873e1a67eea335e84ffab1
-  data.tar.gz: 0e6f326c3373eb8716be5b09ec006dcc0a0fcce2
+SHA256:
+  metadata.gz: 508ce7cb53f750ba6b422a41c966b1fbdd46b623dcb311c4410d80c9b3b95f2f
+  data.tar.gz: 28662decb01dd5ae5b943a0f099bf68eaf3bbbfd1b6cb31172eb7d1673238b24
 SHA512:
-  metadata.gz: 0cabe2ffa1e527c286924329ae3c11740cbdeb9445a0698205c5c05157184cadff6c1c97d80b7ce6490790875f905b25f78550494b2a53974eda8946dbce9c59
-  data.tar.gz: c4f0308b365db3ddded71bc6263a2d077038fc3c34ef843aff54d438746c8f36568b9a77963d30fc1d15e0c306c4af8d96d043b0d035a8643a4f1ab70f0c759e
+  metadata.gz: babd9a69b4121f59f3dae1bddc3933d33c083d2f86ad8cc95cd265b8dc7c13c795b8f6803c81764c91a0868357d27f11863bac12c9e83b55bbfbfbfb8f6f2010
+  data.tar.gz: ec774a339d41ba6c95f82bb37f78eb90280f4c238dcbf4b31f1a7b71abdc5c3ee05bbddeb888e99232cffdceb4a112df59de270c7963623deb130b4eb1765ed0

data/lib/informant-rails.rb

@@ -5,16 +5,21 @@ end
 
 module InformantRails
   autoload :Config,             'informant-rails/config'
-  autoload :ConnectionTester,   'informant-rails/connection_tester'
+  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 :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'
+
+  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/client.rb

@@ -3,8 +3,12 @@ require 'net/http'
 module InformantRails
   class Client
 
+    def self.supported_request_methods
+      @supported_request_methods ||= %w(POST PATCH PUT DELETE)
+    end
+
     def self.record(env)
-      new_request.request_url = env['HTTP_REFERER'] unless env['REQUEST_METHOD'] == 'GET'
+      new_request if supported_request_methods.include?(env['REQUEST_METHOD'])
     end
 
     def self.record_action(controller_name, action)
@@ -35,31 +39,24 @@ module InformantRails
       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))
+    def self.transmit(event)
+      Net::HTTP.start(*event.net_http_start_arguments) do |http|
+        http.request(event.post_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 }
+    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] = Request.new
-    end
-
-    def self.api_endpoint
-      @api_endpoint ||= URI("#{Config.collector_host}/api/v1/form_submissions")
+      Thread.current[:informant_request] = Event::FormSubmission.new
     end
 
   end

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

@@ -1,12 +1,12 @@
 module InformantRails
-  class ConnectionTester
+  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('REQUEST_METHOD' => 'POST')
         Client.record_action('Connectivity', 'test')
         Client.request.instance_variable_set('@models', [{
           name: 'TestClass',
@@ -14,7 +14,7 @@ module InformantRails
         }])
         response = Client.transmit(Client.request)
 
-        if response.success?
+        if response.code == '204'
           Rails.logger.info success_message
         else
           Rails.logger.info bad_response_message(response.body)

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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,16 @@
+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/{request.rb → event/form_submission.rb}

@@ -1,5 +1,5 @@
-module InformantRails
-  class Request
+module InformantRails::Event
+  class FormSubmission < Base
     attr_accessor :request_url, :filename, :action
 
     def process_model(model)
@@ -14,15 +14,15 @@ module InformantRails
 
     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
+        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

data/lib/informant-rails/railtie.rb

@@ -3,22 +3,27 @@ module InformantRails
     initializer 'informant' do |config|
       Config.api_token ||= ENV['INFORMANT_API_KEY']
 
-      if Config.enabled?
-        config.middleware.use InformantRails::Middleware
+      begin
+        if Config.enabled?
+          InformantRails::Client.log_client_info
+          InformantRails::Config.filter_parameters = Rails.configuration.filter_parameters
 
-        InformantRails::Config.filter_parameters = Rails.configuration.filter_parameters
+          config.middleware.use InformantRails::Middleware
 
-        ActiveSupport.on_load(:action_controller) do
-          include InformantRails::RequestTracking
-        end
+          ActiveSupport.on_load(:action_controller) do
+            include InformantRails::RequestTracking
+          end
 
-        ActiveSupport.on_load(:active_record) do
-          include InformantRails::ValidationTracking
-        end
+          ActiveSupport.on_load(:active_record) do
+            include InformantRails::ValidationTracking
+          end
 
-        ActiveSupport.on_load(:mongoid) do
-          include InformantRails::ValidationTracking
+          ActiveSupport.on_load(:mongoid) do
+            include InformantRails::ValidationTracking
+          end
         end
+      rescue
+        puts "Unable to bootstrap informant."
       end
     end
   end

data/lib/informant-rails/version.rb

@@ -1,3 +1,3 @@
 module InformantRails
-  VERSION = '1.1.0'
+  VERSION = '2.0.1'
 end

data/lib/tasks/diagnostic.rake

@@ -0,0 +1,9 @@
+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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: informant-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Informant, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.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: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 description: The Informant tracks what users do wrong in your forms so you can make
   them better.
 email:
@@ -38,17 +44,19 @@ files:
 - lib/informant-rails.rb
 - lib/informant-rails/client.rb
 - lib/informant-rails/config.rb
-- lib/informant-rails/connection_tester.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.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
@@ -69,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: The Informant tracks server-side validation errors and gives you metrics

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