RaygunRuby 0.9.7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 j-mcnally
+
+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,43 @@
+# RaygunRuby
+
+Integrate rails with the Raygun.io service.
+
+I, nor kohactive are in anyway associated with the offical raygun.io, we just couldn't wait for them to develop a rails solution so we rolled our own.
+
+Throwing exceptions has never been so much fun.
+
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'RaygunRuby', '0.9.7'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install RaygunRuby
+
+Also generate a raygun.yml with
+    
+    $ rake raygun:install
+
+## Usage
+
+Add the following to which ever config/environment files you want to use with raygun
+    
+    config.middleware.use RaygunRuby::Middleware
+
+## 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/RaygunRuby.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'RaygunRuby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "RaygunRuby"
+  gem.version       = RaygunRuby::VERSION
+  gem.authors       = ["j-mcnally"]
+  gem.email         = ["justin@kohactive.com"]
+  gem.description   = "Raygun api implementation for rails"
+  gem.summary       = "Allows usage of raygun and rails"
+  gem.homepage      = "http://www.kohactive.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "thor"
+  gem.add_runtime_dependency "faraday"
+  gem.add_runtime_dependency "awesome_print"
+
+end

data/lib/RaygunRuby.rb

@@ -0,0 +1,26 @@
+require "RaygunRuby/version"
+require "RaygunRuby/RaygunClientMessage"
+require "RaygunRuby/RaygunMessageDetails"
+require "RaygunRuby/RaygunRequestMessage"
+require "RaygunRuby/RaygunExceptionMessage"
+require "RaygunRuby/RaygunExceptionTraceLineMessage"
+require "RaygunRuby/RaygunMessage"
+require "RaygunRuby/RaygunClient"
+require "RaygunRuby/base"
+
+
+
+module RaygunRuby
+  class Middleware
+    include RaygunRuby::Base
+  end
+  class Config
+    def self.read
+      my_env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || "development"
+      YAML.load_file("#{Rails.root}/config/raygun.yml")["#{my_env}"]
+    end
+  end
+end
+
+require "RaygunRuby/thor_stuff"
+require "RaygunRuby/railties"

data/lib/RaygunRuby/RaygunClient.rb

@@ -0,0 +1,50 @@
+require "faraday"
+
+module RaygunRuby
+  class RaygunClient
+
+
+    def self.send_exception(exception, tags=nil, userCustomData=nil, env=nil)
+      msg = self.build_message(exception, env)
+      self.send_msg(msg)
+
+    end
+
+    def self.build_message(errorException, env)
+
+      message = RaygunMessage.new()
+      message.build(errorException, env)
+
+    end
+
+    def self.send_msg(message)
+      begin
+        apiKey = RaygunRuby::Config::read["apiKey"]
+      rescue 
+        raise "API_KEY not valid, cannot send message to Raygun"
+      end
+      bdy = message.api_attributes.to_json
+
+        connection = Faraday.new 'https://api.raygun.io', :ssl => {:ca_file => "../../vendor/cacert.crt"} do |faraday|
+            faraday.response :logger                  # log requests to STDOUT
+            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+
+        request = connection.post do |req|
+          req.url "/entries"
+          req.headers["X-ApiKey"] = apiKey
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.headers['User-Agent'] = "Hai Raygun"
+          req.body = bdy
+
+        end
+
+        puts request.body
+
+              
+
+    end
+
+
+  end
+end

data/lib/RaygunRuby/RaygunClientMessage.rb

@@ -0,0 +1,20 @@
+module RaygunRuby
+  class RaygunClientMessage
+    attr_accessor :name, :version, :clientUrl
+
+    def initialize
+      self.name = "RaygunRuby"
+      self.version = RaygunRuby::VERSION
+      self.clientUrl = "https://github.com/j-mcnally/RaygunRuby"
+      self
+    end
+
+    def api_attributes
+      {
+        name: self.name,
+        version: self.version,
+        clientUrl: self.clientUrl
+      }
+    end
+  end
+end

data/lib/RaygunRuby/RaygunExceptionMessage.rb

@@ -0,0 +1,29 @@
+module RaygunRuby
+  class RaygunExceptionMessage
+    attr_accessor :message, :classname, :stacktrace, :filename, :data
+    def initialize(exception)
+      exceptionClass = exception.class.name
+      self.message = "#{exceptionClass}: #{exception.message}"
+      begin
+        backTraceLine = exception.backtrace.first
+        self.filename = File::basename(backTraceLine.split(":").first)
+        self.classname = File.basename(self.filename, ".rb").camelize
+      rescue
+        self.filename = "Unknown"
+        self.classname = "Unknown"
+      end
+      self.stacktrace = exception.backtrace.collect{|bt| RaygunExceptionTraceLineMessage.new(bt) }
+      self.data = nil
+      self
+    end
+    def api_attributes
+      {
+        "Message" => self.message,
+        "ClassName" => self.classname,
+        "StackTrace" => self.stacktrace.collect{|s| s.api_attributes},
+        "FileName" => self.filename,
+        "Data" => self.data
+      }
+    end
+  end
+end

data/lib/RaygunRuby/RaygunExceptionTraceLineMessage.rb

@@ -0,0 +1,23 @@
+module RaygunRuby
+  class RaygunExceptionTraceLineMessage
+    attr_accessor :lineNumber, :className, :fileName, :methodName
+
+    def initialize (logline)
+      line = logline.split(":")
+      self.lineNumber = line[1]
+      self.fileName = line[0]
+      self.methodName = line[2]
+      self.className = File.basename(self.fileName, ".rb")
+    end
+
+    def api_attributes
+      {
+        "LineNumber" => self.lineNumber.to_i,
+        "ClassName" => self.className,
+        "FileName" => self.fileName,
+        "MethodName" => self.methodName
+      }
+    end
+
+  end
+end

data/lib/RaygunRuby/RaygunMessage.rb

@@ -0,0 +1,25 @@
+require "socket"
+
+module RaygunRuby
+  class RaygunMessage
+    attr_accessor :occurredOn, :details
+    def initialize
+      self.occurredOn = Time.now.gmtime.strftime("%Y-%m-%d\T%H:%M:%S")
+      self.details = RaygunMessageDetails.new
+      self
+    end
+    def build(exception,env=nil)
+      self.details.machineName = Socket.gethostname
+      self.details.error = RaygunExceptionMessage.new(exception)
+      self.details.request = RaygunRequestMessage.new(env)
+      self.details.client = RaygunClientMessage.new
+      self
+    end
+    def api_attributes
+      {
+        "Details" => self.details.api_attributes,
+        "OccurredOn" => self.occurredOn
+      }
+    end
+  end
+end

data/lib/RaygunRuby/RaygunMessageDetails.rb

@@ -0,0 +1,20 @@
+module RaygunRuby
+  class RaygunMessageDetails
+    attr_accessor :error, :machineName, :request, :client, :version, :tags, :userCustomData
+    def initialize
+      self.tags=[]
+      self
+    end
+    def api_attributes
+      {
+        "Error" => self.error.api_attributes,
+        "MachineName" => self.machineName,
+        "Request" => self.request.api_attributes,
+        "Client" => self.client.api_attributes,
+        "Version" => self.version,
+        "Tags" => self.tags.to_json,
+        "UserCustomData" => self.userCustomData
+      }
+    end
+  end
+end

data/lib/RaygunRuby/RaygunRequestMessage.rb

@@ -0,0 +1,38 @@
+require "awesome_print"
+
+module RaygunRuby
+  class RaygunRequestMessage
+    attr_accessor :hostName, :url, :httpMethod, :ipAddress, :queryString, :headers, :data, :form, :rawData
+    def initialize(env)
+      return nil if env.nil?
+      self.hostName = env["HTTP_HOST"]
+      self.url = env["PATH_INFO"]
+      self.httpMethod = env["REQUEST_METHOD"]
+      self.ipAddress = env["REMOTE_ADDR"]
+      self.queryString = env["QUERY_STRING"].present? ? env["QUERY_STRING"] : nil
+      header_hash = env.keys.reject{|x| !x.include?("HTTP")}.map{|k| {"#{k}" => env[k]} }.map(&:to_a).flatten(1).reduce({}) {|h,(k,v)| h[k] = v; h}
+      hash_out = header_hash.dup
+      header_hash.each { |k, v| hash_out[k.to_s.sub("HTTP_", "").sub("_", " ").titleize.sub(" ", "-")] = v; hash_out.delete(k) }
+      header_hash = hash_out
+      self.headers = header_hash
+      self.data = env.inspect.to_s
+      self.form = env["action_dispatch.request.parameters"] rescue {}
+      self.rawData = nil
+    end
+
+    def api_attributes
+      {
+        hostName: self.hostName,
+        url: self.url,
+        httpMethod: self.httpMethod,
+        ipAddress: self.ipAddress,
+        queryString: self.queryString,
+        headers: self.headers,
+        data: self.data,
+        form: self.form,
+        rawData: self.rawData
+      }
+    end
+
+  end
+end

data/lib/RaygunRuby/base.rb

@@ -0,0 +1,51 @@
+require "awesome_print"
+
+module RaygunRuby
+  module Base
+    def self.included(base)
+      base.class_eval do
+        include Includes
+      end
+    end
+  end
+  module Includes
+
+    def initialize(app)
+      @ready = false
+      begin
+        key = RaygunRuby::Config::read["apiKey"]
+        puts "RayGun is charged"
+        @ready = true
+      rescue
+        puts "RayGun API Key is not configured::: run 'rake raygun:install'"
+      end
+
+
+
+      @app = app
+
+    end 
+
+    def call(env)
+      dup._call(env) if @ready
+    end
+    
+    def _call(env)
+      begin
+        @app.call(env)
+      rescue Exception => exception
+        raygun_handle_and_rethrow(exception,env)
+      end
+    end
+    def raygun_handle_and_rethrow(exception, env)
+      backtrace = exception.backtrace.join("\n")
+      message = exception.message
+      #ap env
+
+      RaygunRuby::RaygunClient::send_exception(exception, nil, nil, env)
+
+      raise exception
+    end
+
+  end
+end

data/lib/RaygunRuby/railties.rb

@@ -0,0 +1,5 @@
+class LoadTasks < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+  end
+end

data/lib/RaygunRuby/tasks/install.rake

@@ -0,0 +1,7 @@
+namespace :raygun do
+  desc "install raygun into project"
+  task :install => [:environment] do
+    ts = RaygunRuby::ThorStuff.new
+    ts.invoke :create_raygun_config
+  end
+end

data/lib/RaygunRuby/thor_stuff.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'thor'
+module RaygunRuby
+  class ThorStuff < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+    
+
+    desc "create_raygun_config", "Create a raygun config"
+    def create_raygun_config
+      @apiKey = ask "What is your RayGun api key?:"
+      template "../../templates/raygun_yaml.tt", "#{Rails.root}/config/raygun.yml"
+      puts "Generating raygun.yml"
+      puts "You can edit the configuration in config/raygun.yml"
+    end
+
+  end
+end