appinsights 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f03d2c25eee7d16cd76e865f2d712a06d4943f9a
+  data.tar.gz: e3d979812ef53af3bed0545a22818b73679e2a9f
+SHA512:
+  metadata.gz: 23adae4aeaadfa9c3acce91dec880c60c0b33c6ba2e6917ebc804aeb99ca5c6002dbabc8b27ad63958db222c022c839b5d55e68365724682f93a77a28948e7bf
+  data.tar.gz: e2f65f4b5c0e5df1c524798735e134a2ee56ef5a9ece5b7e3e4bc3b0cafb581ef5007a0ea23f577a1b6ebe035448833da3209a27b1639bf5653072da0d12df15

data/README.md

@@ -0,0 +1,2 @@
+# appinsights
+Microsoft Application Insights AutoInstaller for Ruby frameworks

data/appinsights.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = 'appinsights'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = 'Application Insights Auto-Installer'
+  s.description = 'Application Insights AutoInstaller for Ruby'
+  s.authors     = ['Emiliano Mancuso']
+  s.email       = ['emiliano.mancuso@gmail.com']
+  s.homepage    = 'http://github.com/citrusbyte/appinsights'
+  s.license     = 'MIT'
+
+  s.files = Dir[
+    'README.md',
+    'Rakefile',
+    'lib/**/*.rb',
+    '*.gemspec',
+    'test/*.*'
+  ]
+
+  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'
+end

data/lib/appinsights.rb

@@ -0,0 +1,20 @@
+require_relative 'errors'
+require_relative 'context'
+require_relative 'middlewares'
+require_relative 'config_loader'
+
+module AppInsights
+  if defined?(Rails::VERSION)
+    require_relative 'frameworks/rails'
+  else
+    puts <<-EOS
+      Config file not loaded.
+      Use AppInsights::ConfigLoader.new root, filename
+      to setup the Context and middlewares.
+    EOS
+
+    # Initialize for other frameworks
+    #
+    # loader = ConfigLoader.new __FILE__
+  end
+end

data/lib/config_loader.rb

@@ -0,0 +1,36 @@
+require 'toml'
+
+module AppInsights
+  class ConfigLoader
+    attr_reader :settings, :filename
+
+    def initialize(root, filename = nil)
+      @root = root
+      @filename = filename || default_file
+      @filename = File.join(@root, @filename) if @filename
+
+      unless @filename && File.exist?(@filename)
+        fail AppInsights::ConfigFileNotFound
+      end
+
+      @settings = TOML.load_file @filename
+
+      AppInsights::Context.configure @settings['ai']
+      AppInsights::Middlewares.configure @settings['middleware']
+    end
+
+    private
+
+    def default_file
+      default_paths.compact.find { |path| File.exist? File.join(@root, path) }
+    end
+
+    def default_paths
+      @default_paths ||= [
+        './config/application_insights.toml',
+        './application_insights.toml',
+        # ENV['AI_CONFIG_PATH']
+      ]
+    end
+  end
+end

data/lib/context.rb

@@ -0,0 +1,44 @@
+require 'application_insights'
+
+module AppInsights
+  class Context
+    class << self
+      def configure(config = {})
+        @context = telemetry_client.context
+
+        contracts.each do |contract|
+          instance = configure_contract(contract.capitalize, config)
+          @context.send :"#{contract}=", instance
+        end
+
+        @context.instrumentation_key = config['instrumentation_key']
+        @context.properties = extract_custom_properties config
+
+        @context
+      end
+
+      def telemetry_client
+        @client ||= ApplicationInsights::TelemetryClient.new
+      end
+
+      private
+
+      def configure_contract(contract, config)
+        const = ApplicationInsights::Channel::Contracts.const_get contract
+
+        const.new config[contract.downcase]
+      rescue NameError
+        nil
+      end
+
+      # Custom properties are defined at [ai] level of the config file.
+      def extract_custom_properties(config)
+        config.reject { |k, v| k.to_s == 'instrumentation_key' || v.is_a?(Hash) }
+      end
+
+      def contracts
+        %w(user device session location operation application)
+      end
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,4 @@
+module AppInsights
+  class UnknownMiddleware < StandardError; end
+  class ConfigFileNotFound < StandardError; end
+end

data/lib/frameworks/rails.rb

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

data/lib/middlewares.rb

@@ -0,0 +1,40 @@
+require_relative 'middlewares/exception_handling'
+
+module AppInsights
+  class Middlewares
+    class << self
+      def configure(settings = {})
+        @settings = settings || {}
+        @enabled_middlewares = constantize_middlewares
+      end
+
+      def enabled
+        @enabled_middlewares || []
+      end
+
+      def settings
+        @settings || {}
+      end
+
+      private
+
+      def constantize_middlewares
+        constants = @settings.map do |middleware|
+          begin
+            if middleware['enabled']
+              c = const_get middleware['name']
+              args = middleware['initialize'] || {}
+
+              [c, args]
+            end
+          rescue NameError => e
+            # FIXME: Log, ignore or fail?
+            raise AppInsights::UnknownMiddleware, e.message
+          end
+        end
+
+        constants.compact.uniq
+      end
+    end
+  end
+end

data/lib/middlewares/exception_handling.rb

@@ -0,0 +1,18 @@
+require 'application_insights'
+
+module AppInsights
+  class ExceptionHandling
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call env
+    rescue Exception => exception
+      tc = AppInsights::Context.telemetry_client
+      tc.track_exception exception
+
+      raise exception
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,8 @@
+task :default => :test
+
+desc 'Run tests'
+task :test do
+  require File.expand_path("./test/helper", File.dirname(__FILE__))
+
+  Dir["test/**/*_test.rb"].each { |file| load file }
+end

data/test/config_loader_test.rb

@@ -0,0 +1,56 @@
+require_relative 'helper'
+require 'application_insights'
+
+describe AppInsights::ConfigLoader do
+  before do
+    AppInsights::Context.tap do |klass|
+      klass.instance_variable_set :@context, nil
+      klass.instance_variable_set :@client, nil
+    end
+
+    AppInsights::Middlewares.tap do |klass|
+      klass.instance_variable_set :@settings, nil
+      klass.instance_variable_set :@enabled_middlewares, nil
+    end
+  end
+
+  describe 'initialize' do
+    it 'fails when there is no configuration file' do
+      assert_raises AppInsights::ConfigFileNotFound do
+        AppInsights::ConfigLoader.new '.'
+      end
+    end
+
+    it 'loads the config file from the default path' do
+      loader = AppInsights::ConfigLoader.new './test'
+
+      deny loader.settings.empty?
+    end
+
+    it 'loads the config file from the given filename' do
+      loader = AppInsights::ConfigLoader.new './test/config', 'non_default_file.toml'
+
+      deny loader.settings.empty?
+    end
+
+    it 'autoconfigure the Context and middlewares' do
+      tc = AppInsights::Context.telemetry_client
+      settings = AppInsights::Middlewares.settings
+      middlewares = AppInsights::Middlewares.enabled
+
+      deny tc.context.instrumentation_key
+      assert settings.empty?
+      assert middlewares.empty?
+
+      AppInsights::ConfigLoader.new './test'
+
+      tc = AppInsights::Context.telemetry_client
+      settings = AppInsights::Middlewares.settings
+      middlewares = AppInsights::Middlewares.enabled
+
+      assert tc.context.instrumentation_key
+      deny settings.empty?
+      deny middlewares.empty?
+    end
+  end
+end

data/test/context_test.rb

@@ -0,0 +1,49 @@
+require_relative 'helper'
+
+describe AppInsights::Context do
+  before do
+    @configs = {
+      'instrumentation_key' => 'a_key',
+      'custom' => 4,
+      'properties' => 'belong to the context',
+      'application' => {
+        'ver' => '0.0.1'
+      },
+      'device' => {
+        'id' => 'asdfghjkl1',
+        'os' => 'OSX'
+      }
+    }
+  end
+
+  describe 'configure' do
+    it 'returns a ApplicationInsights::Channel::TelemetryContext object' do
+      context = AppInsights::Context.configure
+
+      assert_equal ApplicationInsights::Channel::TelemetryContext, context.class
+    end
+
+    it 'accepts a hash to set Context values' do
+      context = AppInsights::Context.configure @configs
+
+      assert_equal 'a_key', context.instrumentation_key
+      assert_equal '0.0.1', context.application.ver
+    end
+  end
+
+  describe 'telemetry_client' do
+    before do
+      AppInsights::Context.configure @configs
+
+      @client = AppInsights::Context.telemetry_client
+    end
+
+    it 'returns an instance of ApplicationInsights::TelemetryClient' do
+      assert_equal ApplicationInsights::TelemetryClient, @client.class
+    end
+
+    it 'sets the context to the Telemetry Client' do
+      assert_equal 'a_key', @client.context.instrumentation_key
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+require 'minitest/autorun'
+require 'appinsights'
+
+def deny(condition, message = 'Expected condition to be unsatisfied')
+  assert !condition, message
+end

data/test/middlewares_test.rb

@@ -0,0 +1,63 @@
+require_relative 'helper'
+
+describe AppInsights::Middlewares do
+  before do
+    @configs = [
+      {
+        'name'    => 'AppInsights::ExceptionHandling',
+        'enabled' => true
+      },
+      {
+        'name'    => 'ApplicationInsights::Rack::TrackRequest',
+        'enabled' => false
+      }
+    ]
+  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
+
+      enabled = AppInsights::Middlewares.enabled
+      expected = [[AppInsights::ExceptionHandling, {}]]
+
+      deny enabled.empty?
+      assert_equal expected, enabled
+    end
+
+    it 'returns an empty Array if it was not configured' do
+      assert AppInsights::Middlewares.enabled.empty?
+    end
+  end
+
+  describe 'settings' do
+    it 'returns the settings loaded' do
+      AppInsights::Middlewares.configure @configs
+
+      settings = AppInsights::Middlewares.settings
+
+      deny settings.empty?
+      assert_equal @configs, settings
+    end
+
+    it 'returns an empty Hash if it was not configured' do
+      assert AppInsights::Middlewares.settings.empty?
+    end
+  end
+
+  describe 'configure' do
+    it 'accepts one or zero params' do
+      AppInsights::Middlewares.configure
+
+      assert_equal({}, AppInsights::Middlewares.settings)
+      assert_equal([], AppInsights::Middlewares.enabled)
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: appinsights
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: application_insights
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: Application Insights AutoInstaller for Ruby
+email:
+- emiliano.mancuso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- appinsights.gemspec
+- lib/appinsights.rb
+- lib/config_loader.rb
+- lib/context.rb
+- lib/errors.rb
+- lib/frameworks/rails.rb
+- lib/middlewares.rb
+- lib/middlewares/exception_handling.rb
+- rakefile
+- test/config_loader_test.rb
+- test/context_test.rb
+- test/helper.rb
+- test/middlewares_test.rb
+homepage: http://github.com/citrusbyte/appinsights
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Application Insights Auto-Installer
+test_files: []