project_106 1.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in project_106.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 WeboniseLab
+
+MIT License
+
+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,37 @@
+# Project106
+
+Project 106 is a errors and exception tracking system
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'project_106'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Go to Terminal and Run
+
+    project_106
+
+This will install node_js in your system
+Skip this if you have node js already install.
+
+
+Then run
+
+    rails generate project106:install yourapikey
+
+This will add issential files to your rails app.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/project106/error_controller.rb

@@ -0,0 +1,7 @@
+module Project106
+  class ErrorController < ::ApplicationController
+    def routing
+      render :file => "#{Rails.root}/public/404.html", :status => 404, :layout => false
+    end
+  end
+end

data/bin/project_106

@@ -0,0 +1,4 @@
+#!/usr/bin/project_106
+
+require "project_106"
+Project106.install_nodejs

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match '*a', :to => 'project106/error#routing'
+end

data/lib/generators/project106/install_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module Project106
+  class InstallGenerator < Rails::Generators::Base
+    argument :access_token, :type => :string, :banner => 'access_token', :default => :use_env_sentinel
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer
+      say "creating initializer..."
+      if access_token_configured?
+        say "It looks like you've already configured Project106."
+        say "To re-create the config file, remove it first: config/initializers/project_106.rb"
+        exit
+      end
+
+      if access_token === :use_env_sentinel
+        say "Generator run without an access token; assuming you want to configure using an environment variable."
+        say "You'll need to add an environment variable PROJECT106_ACCESS_TOKEN with your access token:"
+        say "\n$ export PROJECT106_ACCESS_TOKEN=yourtokenhere"
+        say "\nIf that's not what you wanted to do:"
+        say "\n$ rm config/initializers/project_106.rb"
+        say "$ rails generate project106:install yourtokenhere"
+        say "\n"
+      else
+        say "access token: " << access_token
+      end
+
+      template 'initializer.rb', 'config/initializers/project_106.rb',
+        :assigns => { :access_token => access_token_expr }
+    end
+
+    def access_token_expr
+      if access_token === :use_env_sentinel
+        "ENV['PROJECT106_ACCESS_TOKEN']"
+      else
+        "'#{access_token}'"
+      end
+    end
+
+    def access_token_configured?
+      File.exists?('config/initializers/project_106.rb')
+    end
+  end
+end

data/lib/generators/project106/templates/initializer.rb

@@ -0,0 +1,3 @@
+Project106.configure do |config|
+  config.access_token = <%= access_token_expr %>
+end

data/lib/node_handler.js

@@ -0,0 +1,54 @@
+var http = require('http');
+
+// catch the data from command line argument
+var data = process.argv[2]
+
+// parsing data
+jdata = JSON.parse(data);
+
+// create the JSON object
+jsonObject = JSON.stringify(jdata);
+
+// prepare the header
+var postheaders = {
+    'Content-Type' : 'application/json',
+    'Content-Length' : Buffer.byteLength(jsonObject, 'utf8')
+};
+
+// the post options
+var optionspost = {
+    host : 'beta.erreport.io',
+    path : '/api/v1/error_reports',
+    method : 'POST',
+    headers : postheaders
+};
+
+console.info('Options prepared:');
+console.info(optionspost);
+console.info('Do the POST call');
+
+// do the POST call
+var reqPost = http.request(optionspost, function(res) {
+    console.log("statusCode: ", res.statusCode);
+    console.log("headers: ", res.headers);
+ 
+    res.on('data', function(d) {
+        console.info('POST result:\n');
+        data = JSON.parse(d)
+        console.error('\n[Project-106] Response status');
+        console.error(data['status']);
+        console.error('\n[Project-106] Response Message');
+        console.error(data['message']);
+        console.info('\n\nPOST completed');
+        console.error("\n\n[Project-106] Exception Reporting Finished to Project-106 server using node js");
+    });
+});
+ 
+// write the json data
+reqPost.write(jsonObject);
+reqPost.end();
+// handle error
+reqPost.on('error', function(e) {
+    console.error("[Project-106] Error while reporting exception to project-106 in node support");
+    console.error(e);
+});

data/lib/project_106.rb

@@ -0,0 +1,112 @@
+require 'net/http'
+require "json"
+require "shellwords"
+require "fileutils"
+require 'benchmark'
+require "project_106/version"
+require "project_106/configuration"
+require 'project_106/exception_reporter'
+require 'project_106/log_reporter'
+require 'rails'
+require "project_106/railtie" if defined? Rails
+require "active_support/dependencies"
+
+module Project106
+  include LogReporter
+
+  # install nodeJS on client machine
+  def self.install_nodejs
+    puts "Installing nodejs dependencies\n"
+    `sudo apt-get install python-software-properties python g++ make`
+    puts "Adding nodejs ppa\n"
+    `sudo add-apt-repository ppa:chris-lea/node.js`
+    puts "Updating system\n"
+    `sudo apt-get update`
+    puts "Installing nodeJS\n"
+    `sudo apt-get install nodejs`
+    puts "NodeJS Installed ...\n"
+  end
+
+  class << self
+    attr_writer :configuration
+    include LogReporter
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # give memory usage of process using unix shell command
+    # def get_memory_usage
+    #   `ps -o rss= -p #{Process.pid}`.to_i
+    # end
+
+    def append_access_token_to_data(data)
+      data[:api_key] = configuration.access_token
+      data
+    end
+
+    # Making api call to send error report to project-106 server
+    def report_exception_to_project_106_server(data)
+
+      # Append api_key to data
+      data = append_access_token_to_data(data)
+
+      # If handler == node then request data will be pass to nodejs to make api call
+      # If handler == ruby then request data will be directly pass through ruby api call
+      handler = "node"
+      begin
+        # benchmarking code
+        # Benchmark.bm do |bm|
+
+          if handler == "node"
+            # bm.report("Node") do
+
+            #   before = get_memory_usage
+            #   report_log "BEFORE: " + before.to_s
+
+
+              # Pass request data to node_handler.js which will make api call to project-106-server
+              # Stringifing data
+              jdata = data.to_json
+              # Get node_handler path
+              node_handler = File.join(File.dirname(__FILE__), "node_handler.js")
+              report_log "[Project-106] Calling NODE script to send data to project-106 server"
+              `node #{node_handler} #{Shellwords.escape(jdata)}`
+
+              # after = get_memory_usage
+              # report_log "AFTER: " + (after).to_s
+              # report_log "Node Memory Usage: " + (after-before).to_s
+
+            # end
+          else
+            # bm.report("Ruby") do
+
+            #   before = get_memory_usage
+            #   report_log "BEFORE: " + before.to_s
+
+              # Ruby api call to pass request data to project-106-server
+              report_log "[Project-106] Calling RUBY script to send data to project-106 server"
+              url = URI.parse('http://localhost:3000/api/v1/error_reports')
+              resp = Net::HTTP.post_form(url, data)
+              report_log "[Project-106] Exception Reported to Project-106 server"
+              # after = get_memory_usage
+              # report_log "AFTER: " + (after).to_s
+              # report_log "Ruby Memory Usage: " + (after-before).to_s
+
+            # end
+          end
+
+        # end
+      rescue => e
+        report_log "[Project-106] Error reporting exception to Project-106: #{e}"
+      end
+    end
+  end
+end
+
+# Require engine
+require "project_106/engine"

data/lib/project_106/configuration.rb

@@ -0,0 +1,13 @@
+module Project106
+  class Configuration
+
+    attr_accessor :access_token
+    attr_accessor :endpoint
+
+    DEFAULT_ENDPOINT = 'http://stage106.weboapps.com/api/v1/error_requests/'
+
+    def initialize
+      @endpoint = DEFAULT_ENDPOINT
+    end
+  end
+end

data/lib/project_106/engine.rb

@@ -0,0 +1,3 @@
+module Project106
+  class Engine < Rails::Engine; end
+end

data/lib/project_106/exception_reporter.rb

@@ -0,0 +1,14 @@
+require 'project_106/log_reporter'
+require 'project_106/request_data_extractor'
+
+module Project106
+  module ExceptionReporter
+    include LogReporter
+    include RequestDataExtractor
+    def report_exception_to_project_106(env, exception)
+      report_log "[Project106] Reporting Exception: #{exception}", :error
+      req_data = extract_request_data_from_rack(env, exception)
+      Project106.report_exception_to_project_106_server(req_data)
+    end
+  end
+end

data/lib/project_106/log_reporter.rb

@@ -0,0 +1,13 @@
+module Project106
+  module LogReporter
+    # Call to the rails default logger method with message and level
+    # level can be error, debug, info, etc
+    def report_log(message, level = :debug)
+      if defined?(Rails)
+        ::Rails.logger.send(level, message)
+      else
+        puts message
+      end
+    end
+  end
+end

data/lib/project_106/middleware/rails/show_exceptions.rb

@@ -0,0 +1,37 @@
+module Project106
+  module Middleware
+    module Rails
+      module ShowExceptions
+        include ExceptionReporter
+
+        # catching rails middleware render_exception method call and
+        # doing project-106 error catching task and
+        # again continue with rails render_exception method
+        def render_exception_with_project_106(env, exception)
+          key = 'action_dispatch.show_detailed_exceptions'
+
+          # don't report production exceptions here as it is done below
+          # in call_with_project_106() when show_detailed_exception is false
+          if not env.has_key?(key) or env[key]
+            # sending exception to project-106 to collect exception data
+            report_exception_to_project_106(env, exception)
+          end
+          render_exception_without_project_106(env, exception)
+        end
+
+        def call_with_project_106(env)
+          call_without_project_106(env)
+        rescue => exception
+          # won't reach here if show_detailed_exceptions is true
+          report_exception_to_project_106(env, exception)
+          raise exception
+        end
+
+        def self.included(base)
+          base.send(:alias_method_chain, :call, :project_106)
+          base.send(:alias_method_chain, :render_exception, :project_106)
+        end
+      end
+    end
+  end
+end

data/lib/project_106/railtie.rb

@@ -0,0 +1,35 @@
+require 'active_support/all'
+require 'rails'
+require 'project_106/log_reporter'
+require 'project_106/request_data_extractor'
+
+module Project106
+  class Railtie < Rails::Railtie
+    include RequestDataExtractor
+    include LogReporter
+
+    config.after_initialize do
+      # Catch uninitialized typed errors in ErrorController#routing
+      ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, start, finish, id, payload|
+        if payload[:exception].present?
+        elsif payload[:controller] == "Project106::ErrorController"
+          req_data = extract_request_data_from_payload(payload)
+          Project106.report_exception_to_project_106_server(req_data)
+          report_log "[Project-106] Uninitialized Routing Error"
+        end
+      end
+
+      # Catch all other rails error except routing error in the same way as rails did
+      if defined?(ActionDispatch::DebugExceptions)
+        # Rails 3.2.x
+        require 'project_106/middleware/rails/show_exceptions'
+        ActionDispatch::DebugExceptions.send(:include, Project106::Middleware::Rails::ShowExceptions)
+      elsif defined?(ActionDispatch::ShowExceptions)
+        # Rails 3.0.x and 3.1.x
+        require 'project_106/middleware/rails/show_exceptions'
+        ActionDispatch::ShowExceptions.send(:include, Project106::Middleware::Rails::ShowExceptions)
+      end
+
+    end
+  end
+end

data/lib/project_106/request_data_extractor.rb

@@ -0,0 +1,134 @@
+module Project106
+  module RequestDataExtractor
+    # Collecting data from rack to be send to project-106 server
+    def extract_request_data_from_rack(env, exception)
+      rack_req = Rack::Request.new(env)
+      request_params = project_106_request_params(env)
+
+      get_params = project_106_get_params(rack_req)
+      post_params = project_106_post_params(rack_req)
+      cookies = project_106_request_cookies(rack_req)
+      session = env['rack.session.options']
+
+      params = request_params.merge(get_params).merge(post_params)
+
+      # Collect data from rails env.
+      request_data = {
+                      :params => params,
+                      :url => project_106_url(env),
+                      :user_ip => project_106_user_ip(env),
+                      :headers => project_106_headers(env),
+                      :method => project_106_request_method(env),
+                      :error => {
+                        :message => exception.message,
+                        :backtrace => exception.backtrace,
+                        :error_controller => params[:controller],
+                        :error_action => params[:action]
+                      }
+                     }
+      # Excluding session and cookies from request data
+                      # :cookies => cookies,
+                      # :session => session,
+
+      # Data to be sent to project-106 server through api call in case of rails error except routing
+      # sorting out data from request_data which might have extra data.
+      # note : remove this once finalize data to be send to project-106 server
+      # req_data = {
+      #               "error_controller" => request_data[:params][:controller],
+      #               "error_action" => request_data[:params][:action],
+      #               "error_format" => "Not Assigned",
+      #               "method" => request_data[:method],
+      #               "path" => request_data[:url],
+      #               "error" => "Not Assigned",
+      #               "error_info" => exception.inspect
+      #             }
+    end
+
+    # Data to be sent to project-106 server through api call in case of routing error
+    def extract_request_data_from_payload(payload)
+
+      # Note : remove this once finalize data to be send to project-106 server
+
+      # {
+      #   "error_controller" => payload[:controller],
+      #   "error_action" => payload[:action],
+      #   "error_format" => payload[:format],
+      #   "method" => payload[:method],
+      #   "path" => payload[:path],
+      #   "error" => "routing error",
+      #   "error_info" => "It may be that the user have misspelled or devs have forgot to ensure the path"
+      # }
+
+      request_data = {
+                :params => "",
+                :url => payload[:path],
+                :user_ip => "",
+                :headers => "",
+                :method => payload[:method],
+                :error => {
+                  :message => "routing error",
+                  :backtrace => "",
+                  :error_controller => payload[:controller],
+                  :error_action => payload[:action],
+                }
+               }
+    end
+
+    private
+
+    # Methods for collecting data required in method "extract_request_data_from_rack"
+    # from rack
+    def project_106_request_params(env)
+      route = ::Rails.application.routes.recognize_path(env['PATH_INFO']) rescue {}
+      {
+        :controller => route[:controller],
+        :action => route[:action],
+        :format => route[:format],
+      }.merge(env['action_dispatch.request.parameters'] || {})
+    end
+
+    def project_106_get_params(rack_req)
+      rack_req.GET
+    rescue
+      {}
+    end
+
+    def project_106_post_params(rack_req)
+      rack_req.POST
+    rescue
+      {}
+    end
+
+    def project_106_request_cookies(rack_req)
+      rack_req.cookies
+    rescue
+      {}
+    end
+
+    def project_106_url(env)
+      scheme = env['rack.url_scheme']
+      host = env['HTTP_HOST'] || env['SERVER_NAME']
+      path = env['ORIGINAL_FULLPATH'] || env['REQUEST_URI']
+      unless path.nil? || path.empty?
+        path = '/' + path.to_s if path.to_s.slice(0, 1) != '/'
+      end
+
+      [scheme, '://', host, path].join
+    end
+
+    def project_106_user_ip(env)
+      (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']).to_s
+    end
+
+    def project_106_headers(env)
+      env.keys.grep(/^HTTP_/).map do |header|
+        name = header.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+        { name => env[header] }
+      end.inject(:merge)
+    end
+
+    def project_106_request_method(env)
+      env['REQUEST_METHOD'] || env[:method]
+    end
+  end
+end

data/lib/project_106/version.rb

@@ -0,0 +1,3 @@
+module Project106
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: project_106
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Webonise Lab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Error and Exception Tracking.
+email:
+- apurva@weboniselab.com
+- ketan@weboniselab.com
+executables:
+- project_106
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/project106/error_controller.rb
+- lib/node_handler.js
+- lib/project_106/version.rb
+- lib/project_106/configuration.rb
+- lib/project_106/exception_reporter.rb
+- lib/project_106/request_data_extractor.rb
+- lib/project_106/railtie.rb
+- lib/project_106/middleware/rails/show_exceptions.rb
+- lib/project_106/log_reporter.rb
+- lib/project_106/engine.rb
+- lib/project_106.rb
+- lib/generators/project106/templates/initializer.rb
+- lib/generators/project106/install_generator.rb
+- config/routes.rb
+- LICENSE.txt
+- Rakefile
+- Gemfile
+- README.md
+- bin/project_106
+homepage: http://git.weboniselab.com/webonise-lab/project-106
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Project 106 is a errors and exception tracking system
+test_files: []
+has_rdoc: