alacrity-rails 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d2436c6aee506e04789e51dff13fd54d6a98b34
-  data.tar.gz: e95b00c266256fb6d83bc2902be1e0898436bd5d
+  metadata.gz: 58e658428b282d216168227c976cacf6e5c59eb8
+  data.tar.gz: 876cce8bbef6fa0aec2d731ab399789553838eb4
 SHA512:
-  metadata.gz: 6aafe1f3451a311f3aa8f582bbb5ac26ca8de828e028d7e4be1436612e3e7a2bb4f91b8ffc2088fc6dc76187e7cca672b44d1662945859bc11ea42f213d6d3ef
-  data.tar.gz: a3af69969b12b7994c2af0c38216768a713cad663ab44569452623990ba78a0d1ae410b4c1fc2dcfe6fa60878e00b24706401cf5f7d7ee48bb2064b1f89f16ce
+  metadata.gz: 4245addabe189a55fdbb0d5855fd7adc13a61c75e9b00eaa8f72526d35c15322deecbf8f7d5fc68fe177df833a340cd662c93b72de8bc593d10f4913d7185739
+  data.tar.gz: e98059154aa4aa71e622b12eb55a8f11e0754ce91ceaac0d687a716df44000ec54ad73ade80da93dfc3164ca4e63e4ad8d2200098ca5648ff62446297b4195c6

data/lib/alacrity-rails.rb

@@ -5,8 +5,8 @@ end
 
 module AlacrityRails
   autoload :Config,           'alacrity-rails/config'
-  autoload :ConnectionTester, 'alacrity-rails/connection_tester'
   autoload :Client,           'alacrity-rails/client'
+  autoload :Diagnostic,       'alacrity-rails/diagnostic'
   autoload :Middleware,       'alacrity-rails/middleware'
   autoload :ServerConfig,     'alacrity-rails/server_config'
   autoload :VERSION,          'alacrity-rails/version'

data/lib/alacrity-rails/diagnostic.rb

@@ -0,0 +1,92 @@
+module AlacrityRails
+  class Diagnostic
+    def self.run; new.run end
+
+    def logger; @logger ||= Logger.new(STDOUT) end
+
+    def run
+      run_check :api_token_present
+      run_check :valid_api_token
+      run_check :middleware_present
+      run_check :middleware_appears_first
+
+      puts success_message
+      puts assistance_message
+    end
+
+    def run_check(check_name)
+      logger << "CHECK: #{check_name.to_s.humanize}..."
+
+      successful, display_message = public_send(check_name)
+
+      if successful
+        logger << "PASSED\n"
+      else
+        logger << "FAILED\n"
+        logger << display_message
+        logger << assistance_message
+        exit
+      end
+    end
+
+    def api_token_present
+      [
+        Config.api_token.present?,
+        %<
+          The API token could not be found in the server environment.
+
+          You can find it on https://alacrityapp.com then set it in your server config as `ALACRITY_API_TOKEN`.
+        >
+      ]
+    end
+
+    def valid_api_token
+      response = Client.transmit(Transaction::ConnectionTest.new)
+
+      [
+        response.code == '200',
+        %<
+          Oh no! Its seems like we have a problem!
+
+          #{JSON.parse(response.body)['message']}
+        >
+      ]
+    end
+
+    def middleware_present
+      [
+        Rails.application.config.middleware.include?(AlacrityRails::Middleware),
+        %<
+          The AlacrityRails::Middleware is absent from your middleware stack.
+          Make sure your application is not overriding the middleware stack in an initializer.
+        >
+      ]
+    end
+
+    def middleware_appears_first
+      [
+        Rails.application.config.middleware.first == (AlacrityRails::Middleware),
+        %<
+          The AlacrityRails::Middleware is not first in your middleware stack.
+          Anything appearing above it will not be included in metrics tracking.
+
+#{Rails.application.config.middleware.map(&:to_s).to_yaml}
+        >
+      ]
+    end
+
+    private
+
+    def success_message
+      %<
+        Everything looks good!
+
+        You should see data on https://alacrityapp.com shortly after your app receives traffic.
+      >
+    end
+
+    def assistance_message
+      "\nIf you need assistance or have any questions, send an email to support@alacrityapp.com or tweet @alacrityapp and we'll help you out!\n"
+    end
+  end
+end

data/lib/alacrity-rails/version.rb

@@ -1,3 +1,3 @@
 module AlacrityRails
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/tasks/diagnostic.rake

@@ -0,0 +1,8 @@
+namespace :alacrity do
+
+  desc "Tests your app's configuration and connectivity with Alacrity"
+  task :diagnostic => :environment do
+    AlacrityRails::Diagnostic.run
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alacrity-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Alacrity, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,7 +37,7 @@ files:
 - lib/alacrity-rails.rb
 - lib/alacrity-rails/client.rb
 - lib/alacrity-rails/config.rb
-- lib/alacrity-rails/connection_tester.rb
+- lib/alacrity-rails/diagnostic.rb
 - lib/alacrity-rails/middleware.rb
 - lib/alacrity-rails/probe/action_controller.rb
 - lib/alacrity-rails/probe/action_view.rb
@@ -52,7 +52,7 @@ files:
 - lib/alacrity-rails/transaction/server_startup.rb
 - lib/alacrity-rails/transaction/web_transaction.rb
 - lib/alacrity-rails/version.rb
-- lib/tasks/test_connection.rake
+- lib/tasks/diagnostic.rake
 homepage: https://www.alacrityapp.com
 licenses:
 - GPL
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rails Agent for the Alacrity Application Health Platform

data/lib/alacrity-rails/connection_tester.rb

@@ -1,55 +0,0 @@
-module AlacrityRails
-  class ConnectionTester
-    def self.run; new.run end
-
-    def run
-      if Config.api_token.blank?
-        puts missing_api_token_message
-      else
-        response = Client.transmit(Transaction::ConnectionTest.new)
-
-        if response.code == '200'
-          puts success_message
-        else
-          puts bad_response_message(JSON.parse(response.body)['message'])
-        end
-      end
-
-      puts assistance_message
-    end
-
-    private
-
-    def missing_api_token_message
-      %<
-        Your API token could not be found in the configuration. You can find it on https://alacrityapp.com.
-
-          Then add it to your server's environment as `ALACRITY_API_TOKEN`
-
-          OR
-
-          Set it manually with an initializer (config/alacrity.rb)
-            AlacrityRails::Config.api_token = 'your token'>
-    end
-
-    def bad_response_message(server_message)
-      %<
-        Oh no! Its seems like we have a problem!
-
-          #{server_message}>
-    end
-
-    def success_message
-      %<
-        Everything looks good!
-
-        You should see data on https://alacrityapp.com shortly after your app receives traffic.>
-    end
-
-    def assistance_message
-      %<
-        If you need assistance or have any questions, send an email to support@alacrityapp.com or tweet @alacrityapp and we'll help you out!
-      >
-    end
-  end
-end

data/lib/tasks/test_connection.rake

@@ -1,8 +0,0 @@
-namespace :alacrity do
-
-  desc "Verifies your app's ability to communicate with Alacrity"
-  task :test_connection => :environment do
-    AlacrityRails::ConnectionTester.run
-  end
-
-end