appinsights 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f03d2c25eee7d16cd76e865f2d712a06d4943f9a
-  data.tar.gz: e3d979812ef53af3bed0545a22818b73679e2a9f
+  metadata.gz: 01003d9d4c44a67f7f73bb0ff83ce5a4d763a4ac
+  data.tar.gz: 880be6e1ab0a7bbb7726900c7c4af58b7dee518e
 SHA512:
-  metadata.gz: 23adae4aeaadfa9c3acce91dec880c60c0b33c6ba2e6917ebc804aeb99ca5c6002dbabc8b27ad63958db222c022c839b5d55e68365724682f93a77a28948e7bf
-  data.tar.gz: e2f65f4b5c0e5df1c524798735e134a2ee56ef5a9ece5b7e3e4bc3b0cafb581ef5007a0ea23f577a1b6ebe035448833da3209a27b1639bf5653072da0d12df15
+  metadata.gz: fc062486cb66e7ca600f8f278e08a7a7e08cbddf370c4fbe7d5148d396a35439adce123fccbe9261b31134a9ab888284a5e7d7eac44e7c658bf7417794d0df09
+  data.tar.gz: 49ae01dd89528edbfda574e6bd43b33ab4415ccd6ae6502aff308074c7e7cc7c1161183be3512508151fcd43cdf101949f08532b8d31dc946d1bb9b1bec5ce74

data/README.md

@@ -1,2 +1,7 @@
 # appinsights
-Microsoft Application Insights AutoInstaller for Ruby frameworks
+[![Gem Version](https://badge.fury.io/rb/appinsights.svg)](http://badge.fury.io/rb/appinsights)
+[![Build Status](https://travis-ci.org/citrusbyte/appinsights.svg)](https://travis-ci.org/citrusbyte/appinsights)
+[![Code Climate](https://codeclimate.com/github/citrusbyte/appinsights/badges/gpa.svg)](https://codeclimate.com/github/citrusbyte/appinsights)
+[![Dependency Status](https://gemnasium.com/citrusbyte/appinsights.svg)](https://gemnasium.com/citrusbyte/appinsights)
+
+Microsoft Application Insights Auto Installer for Ruby frameworks

data/appinsights.gemspec

@@ -1,6 +1,8 @@
+require_relative 'lib/version'
+
 Gem::Specification.new do |s|
   s.name        = 'appinsights'
-  s.version     = '0.0.1'
+  s.version     = AppInsights::VERSION
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'Application Insights Auto-Installer'
   s.description = 'Application Insights AutoInstaller for Ruby'
@@ -20,5 +22,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'toml-rb', '~> 0.2.1'
   s.add_dependency 'application_insights', '~> 0.5.0'
 
-  s.add_development_dependency 'rack', '~> 1.6', '>= 1.6.0'
+  s.add_development_dependency 'rack', '~> 1.6', '>= 1.0.0'
 end

data/lib/appinsights.rb

@@ -2,19 +2,21 @@ require_relative 'errors'
 require_relative 'context'
 require_relative 'middlewares'
 require_relative 'config_loader'
+require_relative 'installers/base'
 
 module AppInsights
   if defined?(Rails::VERSION)
-    require_relative 'frameworks/rails'
+    require_relative 'installers/rails'
+  elsif defined?(Sinatra::VERSION)
+    require_relative 'installers/sinatra'
   else
-    puts <<-EOS
-      Config file not loaded.
-      Use AppInsights::ConfigLoader.new root, filename
+    require 'logger'
+
+    logger = Logger.new STDOUT
+    logger.info <<-EOS
+      Framework unknown, auto installation suspended.
+      Use AppInsights::BaseInstaller.new app, root, filename
       to setup the Context and middlewares.
     EOS
-
-    # Initialize for other frameworks
-    #
-    # loader = ConfigLoader.new __FILE__
   end
 end

data/lib/config_loader.rb

@@ -27,9 +27,9 @@ module AppInsights
 
     def default_paths
       @default_paths ||= [
+        ENV['AI_CONFIG_RPATH'],
         './config/application_insights.toml',
-        './application_insights.toml',
-        # ENV['AI_CONFIG_PATH']
+        './application_insights.toml'
       ]
     end
   end

data/lib/context.rb

@@ -21,6 +21,10 @@ module AppInsights
         @client ||= ApplicationInsights::TelemetryClient.new
       end
 
+      def context
+        @context
+      end
+
       private
 
       def configure_contract(contract, config)

data/lib/installers/base.rb

@@ -0,0 +1,34 @@
+module AppInsights
+  class BaseInstaller
+    attr_accessor :app, :root, :filename, :logger
+
+    def initialize(app, root, filename = nil, logger = nil)
+      @app, @root, @filename, @logger = app, root, filename, logger
+    end
+
+    def install
+      AppInsights::ConfigLoader.new @root, @filename
+
+      AppInsights::Middlewares.enabled.each do |middleware, args|
+        @app.use middleware, *args.values
+      end
+    rescue AppInsights::ConfigFileNotFound => e
+      @logger.error e.message
+      @logger.info config_file_not_found_message
+    end
+
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
+
+    private
+
+    def config_file_not_found_message
+      <<-EOS
+        Place your config file `application_insights.toml`
+        under the `config` or root directory of your application.
+        Check the README for manual installation.
+      EOS
+    end
+  end
+end

data/lib/installers/rails.rb

@@ -0,0 +1,16 @@
+module AppInsights
+  class RailsInstaller < Rails::Railtie
+    initializer 'appinsights.start_plugin' do |_app|
+      init Rails.root
+    end
+
+    def init(root, filename = nil)
+      installer = AppInsights::Base.new config.app_middleware,
+                                        root,
+                                        filename,
+                                        Rails.logger
+
+      installer.install
+    end
+  end
+end

data/lib/installers/sinatra.rb

@@ -0,0 +1,20 @@
+require_relative 'base'
+
+module AppInsights
+  class SinatraInstaller < Sinatra::Application
+    def self.root
+      File.dirname app_file
+    end
+
+    def self.init(root, filename = nil)
+      installer = AppInsights::Base.new Sinatra::Application,
+                                        root,
+                                        filename
+
+      installer.install
+    end
+
+    # This will call the init method as soon as this file is required
+    SinatraInstaller.init SinatraInstaller.root
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module AppInsights
+  VERSION = '0.0.2'
+end

data/test/base_installer_test.rb

@@ -0,0 +1,50 @@
+require_relative 'helper'
+require_relative 'mock/mock_app'
+require_relative 'mock/mock_logger'
+
+describe AppInsights::Context do
+  before do
+    @app = MockApp.new
+    @root = './test'
+    @logger = MockLogger.new
+  end
+
+  describe 'install' do
+    it 'logs an error if the config file is not found' do
+      installer = AppInsights::BaseInstaller.new @app, @root, 'wrong_file', @logger
+
+      assert @logger.messages.empty?
+
+      installer.install
+
+      deny @logger.messages.empty?
+      assert_equal Logger::ERROR, @logger.messages.first.first
+      assert_equal Logger::INFO, @logger.messages.last.first
+    end
+
+    it 'loads the configs from the file with no errors' do
+      installer = AppInsights::BaseInstaller.new @app, @root, nil, @logger
+
+      assert @logger.messages.empty?
+
+      installer.install
+      context = AppInsights::Context.context
+
+      assert @logger.messages.empty?
+      deny AppInsights::Middlewares.settings.empty?
+      deny AppInsights::Middlewares.enabled.empty?
+      assert_equal 'aaaaaaaa-aaaa-aaaa-aaaa', context.instrumentation_key
+      assert_equal '0.2.0', context.application.ver
+    end
+
+    it 'register the middlewares automatically' do
+      installer = AppInsights::BaseInstaller.new @app, @root, nil, @logger
+
+      assert @app.middlewares.empty?
+
+      installer.install
+
+      deny @app.middlewares.empty?
+    end
+  end
+end

data/test/config_loader_test.rb

@@ -33,6 +33,16 @@ describe AppInsights::ConfigLoader do
       deny loader.settings.empty?
     end
 
+    it 'loads the config file from the ENV variable' do
+      ENV['AI_CONFIG_RPATH'] = 'test/config/non_default_file.toml'
+
+      loader = AppInsights::ConfigLoader.new './'
+
+      deny loader.settings.empty?
+
+      ENV.delete 'AI_CONFIG_RPATH'
+    end
+
     it 'autoconfigure the Context and middlewares' do
       tc = AppInsights::Context.telemetry_client
       settings = AppInsights::Middlewares.settings

data/test/middlewares_test.rb

@@ -2,6 +2,11 @@ require_relative 'helper'
 
 describe AppInsights::Middlewares do
   before do
+    AppInsights::Middlewares.tap do |klass|
+      klass.instance_variable_set :@settings, nil
+      klass.instance_variable_set :@enabled_middlewares, nil
+    end
+
     @configs = [
       {
         'name'    => 'AppInsights::ExceptionHandling',
@@ -14,13 +19,6 @@ describe AppInsights::Middlewares do
     ]
   end
 
-  after do
-    AppInsights::Middlewares.tap do |klass|
-      klass.instance_variable_set :@settings, nil
-      klass.instance_variable_set :@enabled_middlewares, nil
-    end
-  end
-
   describe 'enabled' do
     it 'returns the middlewares enabled' do
       AppInsights::Middlewares.configure @configs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appinsights
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Emiliano Mancuso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -47,7 +47,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.0.0
 description: Application Insights AutoInstaller for Ruby
 email:
 - emiliano.mancuso@gmail.com
@@ -71,10 +71,14 @@ files:
 - lib/config_loader.rb
 - lib/context.rb
 - lib/errors.rb
-- lib/frameworks/rails.rb
+- lib/installers/base.rb
+- lib/installers/rails.rb
+- lib/installers/sinatra.rb
 - lib/middlewares.rb
 - lib/middlewares/exception_handling.rb
+- lib/version.rb
 - rakefile
+- test/base_installer_test.rb
 - test/config_loader_test.rb
 - test/context_test.rb
 - test/helper.rb

data/lib/frameworks/rails.rb

@@ -1,11 +0,0 @@
-module AppInsights
-  class Railtie < Rails::Railtie
-    initializer 'ai_agent.start_plugin' do |_app|
-      AppInsights::ConfigLoader.new Rails.root
-
-      AppInsights::Middlewares.enabled.each do |middleware, args|
-        config.app_middleware.use middleware, *args.values
-      end
-    end
-  end
-end