informant-sinatra 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02f27a46d2c36eb6ddc7b96a0cf1562877ffbf2b287bce94c3e4472417281f04
+  data.tar.gz: d2e4052d06c13b35016fec533114cc4061cf917766274d2d2ea07291dafab28f
+SHA512:
+  metadata.gz: 4df3eff5e97481b98e355b12047f3faae1c97e9ba9aa858bb93b00c0f181ac7e28fc3a46e4a01f321245237c81595338ee7c49243b404302200ae239ba5348d5
+  data.tar.gz: 5fb9ac00ca156dfcb81c45dc60cef3289fe46fe0565578bd2e550be1854ac9ae93bdaff2614356da2aa36b9771caad0184e52d19c7ccbd669c5f5d15abbd8067

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.md

@@ -0,0 +1,115 @@
+# Overview
+
+## [![Homepage](https://s3.amazonaws.com/assets.heroku.com/addons.heroku.com/icons/1347/original.png)](https://www.informantapp.com) InformantSinatra
+
+The `informant-sinatra` gem provides Sinatra hooks for The Informant.
+
+## Compatibility
+
+The informant-sinatra gem officially supports Ruby 2.5+.
+
+It will work automatically with Sinatra 2+ and automatically activate
+validation tracking for ActiveRecord and Mongoid models.
+
+[![pipeline status](https://gitlab.com/informantapp/informant-sinatra/badges/master/pipeline.svg)](https://gitlab.com/informantapp/informant-sinatra/-/commits/master)
+
+## Installation
+
+1. Sign up for an account on https://www.informantapp.com or through one of our
+   parters, [Heroku](https://dashboard.heroku.com) or
+   [Manifold](https://manifold.co).
+2. Add the `informant-sinatra` gem to your `Gemfile`.
+
+   ```
+   gem 'informant-sinatra', group: :production
+   ```
+
+3. Verify the `INFORMANT_API_KEY` is set in your app's environment.
+4. Bootstrap the Informant in your app's setup.
+
+   ```
+   class MySinatraApp < Sinatra::Base
+     register InformantSinatra::Bootstrap
+   ```
+
+5. Deploy with the gem installed.
+6. Submit a form and you'll see it appear in [our web interface](https://console.informantapp.com).
+
+## Troubleshooting
+
+The Informant gem includes a rake task to diagnose connectivity problems. From
+your server environment execute `rake informant:diagnostic` and it will print
+helpful information to the terminal.
+
+Note: Sinatra doesn't load rake tasks from gems by default so you'll need to
+have code in your Rakefile to do it.
+
+## 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.
+
+### Custom Tracking
+
+If you have other objects that conform to the ActiveModel interface, you can
+include validation tracking in your class and it will just work.
+
+```
+class VeryActiveModel
+  include ActiveModel::Model
+  include InformantSinatra::ValidationTracking
+end
+```
+
+## Configuration
+
+Configuration options are specified in the `InformantSinatra::Config` module.
+Reasonable defaults are provided but you can override them as necessary by
+creating an initializer and passing a block to `configure`.
+
+```
+InformantSinatra::Config.configure do |config|
+  config.api_token = ENV['INFORMANT_API_KEY']
+  config.exclude_models = %w(UntrackedModel)
+  config.filter_parameters.push *%w(password password_confirmation)
+  config.value_tracking = true
+end
+```
+
+### api_token
+
+Default Value: `ENV['INFORMANT_API_KEY']`
+
+Example Value: `dff67d9e61eaa8cf110b3d3f3238a671`
+
+This should be set to the API key assigned to you when you provisioned your application. Heroku will automatically add this to your environment when you provision the addon. Otherwise, you can get this from the Informant web application.
+
+### exclude_models
+
+Default Value: `[]`
+
+Example Value: `['Person', 'Employee']`
+
+This allows you to exclude certain models from tracking. If you don't want them
+included in your metrics list their class names as strings here.
+
+### filter_parameters
+
+Default Value: `['password', 'token']`
+
+Example Value: `['password', 'token']`
+
+Any field values with names matching the strings in this array will be excluded
+from tracking.  Sensitive information you wouldn't want to include in your
+server log should be listed here as well.
+
+### value_tracking
+
+Default Value: `true`
+
+Example Value: `false`
+
+This will enable and disable tracking of values globally. If you turn this off,
+no field value information will be tracked at all. This is useful if you have
+compliance or security concerns about the nature of your data.

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-sinatra.rb

@@ -0,0 +1,10 @@
+require 'informant-common'
+
+module InformantSinatra
+  autoload :Bootstrap,          'informant-sinatra/bootstrap'
+  autoload :Config,             'informant-sinatra/config'
+  autoload :Diagnostic,         'informant-sinatra/diagnostic'
+  autoload :Middleware,         'informant-sinatra/middleware'
+  autoload :ValidationTracking, 'informant-sinatra/validation_tracking'
+  autoload :VERSION,            'informant-sinatra/version'
+end

data/lib/informant-sinatra/bootstrap.rb

@@ -0,0 +1,38 @@
+module InformantSinatra
+  module Bootstrap
+    def self.registered(app)
+      return unless InformantCommon::Config.enabled?
+
+      transmit_agent_info
+
+      InformantSinatra::Config.filter_parameters = %w[password token] if InformantSinatra::Config.filter_parameters.empty?
+
+      app.use InformantSinatra::Middleware
+
+      register_validation_trackers
+    rescue StandardError => e
+      puts "Unable to bootstrap informant: #{e.message}"
+    end
+
+    def self.transmit_agent_info
+      InformantCommon::Client.transmit(
+        InformantCommon::Event::AgentInfo.new(
+          agent_identifier: "informant-sinatra-#{InformantSinatra::VERSION}",
+          framework_version: "sinatra-#{Sinatra::VERSION}"
+        )
+      )
+    end
+
+    def self.register_validation_trackers
+      return unless defined?(ActiveSupport)
+
+      ActiveSupport.on_load(:active_record) do
+        include InformantSinatra::ValidationTracking
+      end
+
+      ActiveSupport.on_load(:mongoid) do
+        include InformantSinatra::ValidationTracking
+      end
+    end
+  end
+end

data/lib/informant-sinatra/config.rb

@@ -0,0 +1,35 @@
+module InformantSinatra
+  module Config
+    def self.api_token
+      InformantCommon::Config.api_token
+    end
+
+    def self.api_token=(api_token)
+      InformantCommon::Config.api_token = api_token
+    end
+
+    def self.exclude_models
+      InformantCommon::Config.exclude_models
+    end
+
+    def self.exclude_models=(exclude_models)
+      InformantCommon::Config.exclude_models = exclude_models
+    end
+
+    def self.filter_parameters
+      InformantCommon::Config.filter_parameters
+    end
+
+    def self.filter_parameters=(filter_parameters)
+      InformantCommon::Config.filter_parameters = filter_parameters
+    end
+
+    def self.value_tracking?
+      InformantCommon::Config.value_tracking?
+    end
+
+    def self.value_tracking=(value_tracking)
+      InformantCommon::Config.value_tracking = value_tracking
+    end
+  end
+end

data/lib/informant-sinatra/diagnostic.rb

@@ -0,0 +1,61 @@
+module InformantSinatra
+  class Diagnostic
+    def self.run
+      new.run
+    end
+
+    def run
+      if Config.api_token.nil? || Config.api_token == ''
+        puts missing_api_token_message
+      else
+        response = InformantCommon::Client.transmit(test_form_submission).join.value
+        display_response_message(response)
+      end
+
+      puts assistance_message
+    end
+
+    private
+
+    def missing_api_token_message
+      %(
+        Your API token could not be found in the configuration. You can retrieve it from your Informantapp.com dashboard.
+
+          Then add it to your server's environment as `INFORMANT_API_KEY`
+
+          OR
+
+          Set it manually in your application setup
+
+            InformantSinatra::Config.api_token = 'your token'
+      )
+    end
+
+    def bad_response_message(server_message)
+      "Seems like we have a problem. \"#{server_message}\" in this case."
+    end
+
+    def success_message
+      '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'
+        puts success_message
+      else
+        puts bad_response_message(response.body)
+      end
+    end
+  end
+end

data/lib/informant-sinatra/middleware.rb

@@ -0,0 +1,15 @@
+module InformantSinatra
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      InformantCommon::Client.start_transaction!(env['REQUEST_METHOD'])
+      response = @app.call(env)
+      InformantCommon::Client.current_transaction.handler = env['sinatra.route']
+      InformantCommon::Client.process
+      response
+    end
+  end
+end

data/lib/informant-sinatra/validation_tracking.rb

@@ -0,0 +1,9 @@
+module InformantSinatra
+  module ValidationTracking
+    extend ActiveSupport::Concern
+
+    included do
+      include InformantCommon::ValidationTracking
+    end
+  end
+end

data/lib/informant-sinatra/version.rb

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

data/lib/tasks/diagnostic.rake

@@ -0,0 +1,8 @@
+require 'informant-sinatra'
+
+namespace :informant do
+  desc 'Verify connectivity from your app to Informant'
+  task :diagnostic do
+    InformantSinatra::Diagnostic.run
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: informant-sinatra
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Informant, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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:
+- support@informantapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/informant-sinatra.rb
+- lib/informant-sinatra/bootstrap.rb
+- lib/informant-sinatra/config.rb
+- lib/informant-sinatra/diagnostic.rb
+- lib/informant-sinatra/middleware.rb
+- lib/informant-sinatra/validation_tracking.rb
+- lib/informant-sinatra/version.rb
+- lib/tasks/diagnostic.rake
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The Informant tracks server-side validation errors and gives you metrics
+  you never dreamed of.
+test_files: []