ratchetio 0.0.1

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 ratchetio.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brian Rue
+
+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,38 @@
+# Ratchetio
+
+Ruby gem for Ratchet.io, for reporting exceptions in Rails 3 to Ratchet.io. Requires a Ratchet.io account (you can sign up for free).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ratchetio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ratchetio
+
+Then, create a file config/initializers/ratchetio.rb containing the following:
+
+```
+require 'ratchetio/rails'
+Ratchetio.configure do |config|
+  config.access_token = 'YOUR_RATCHETIO_PROJECT_ACCESS_TOKEN'
+end
+```
+
+## Usage
+
+This gem installs an exception handler into Rails. You don't need to do anything else for it to work.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ratchetio/configuration.rb

@@ -0,0 +1,25 @@
+module Ratchetio
+  class Configuration
+
+    attr_accessor :access_token
+    attr_accessor :environment
+    attr_accessor :root
+    attr_accessor :branch
+    attr_accessor :framework
+    attr_accessor :endpoint
+
+    attr_accessor :logger
+
+    DEFAULT_ENDPOINT = "https://submit.ratchet.io/api/1/item/"
+
+    def initialize
+      @endpoint = DEFAULT_ENDPOINT
+      @framework = 'Plain'
+    end
+
+    # allow params to be read like a hash
+    def [](option)
+      send(option)
+    end
+  end
+end

data/lib/ratchetio/rails/controller_methods.rb

@@ -0,0 +1,55 @@
+module Ratchetio
+  module Rails
+    module ControllerMethods
+    
+      def ratchetio_request_data
+        { 
+          :params => params.to_hash,
+          :url => ratchetio_request_url,
+          :user_ip => ratchetio_user_ip,
+          :headers => ratchetio_request_headers,
+          :GET => request.GET.to_hash,
+          # leaving out POST for now
+          :method => request.method,
+        }
+      end
+
+      private
+
+      def ratchetio_request_url
+        url = "#{request.protocol}#{request.host}"
+        unless [80, 443].include?(request.port)
+          url << ":#{request.port}"
+        end
+        url << request.fullpath
+        url
+      end
+
+      def ratchetio_user_ip
+        # priority: X-Real-Ip, then X-Forwarded-For, then request.remote_ip
+        real_ip = request.env["HTTP_X_REAL_IP"]
+        if real_ip
+          return real_ip
+        end
+        forwarded_for = request.env["HTTP_X_FORWARDED_FOR"]
+        if forwarded_for
+          return forwarded_for
+        end
+        request.remote_ip
+      end
+
+      def ratchetio_request_headers
+        headers = {}
+        request.env.each_pair do |k,v|
+          if k.match(/^HTTP_/)
+            # convert HTTP_CONTENT_TYPE to Content-Type, etc.
+            name = k.split("_", 2)[1].sub("_", "-").split(/(\W)/).map(&:capitalize).join
+            headers[name] = v
+          end
+        end
+        headers
+      end
+
+    end
+  end
+end

data/lib/ratchetio/rails/middleware/exception_catcher.rb

@@ -0,0 +1,27 @@
+module Ratchetio
+  module Rails
+    module Middleware
+      module ExceptionCatcher
+        def self.included(base)
+          base.send(:alias_method_chain, :render_exception, :ratchetio)
+        end
+
+        def render_exception_with_ratchetio(env, exception)
+          # wrap everything in a begin-rescue block
+          begin
+            controller = env['action_controller.instance']
+            request_data = controller.try(:ratchetio_request_data)
+            Ratchetio.report_request_exception(env, exception, request_data)
+          rescue Exception => exc
+            # TODO use logger here?
+            puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: " 
+            puts exc
+          end
+
+          # now continue as normal
+          render_exception_without_ratchetio(env, exception)
+        end
+      end
+    end
+  end
+end

data/lib/ratchetio/rails.rb

@@ -0,0 +1,22 @@
+require 'ratchetio'
+
+module Ratchetio
+  module Rails
+    def self.initialize
+      rails_logger = if defined?(::Rails.logger)
+                       ::Rails.logger
+                     elsif defined?(RAILS_DEFAULT_LOGGER)
+                       RAILS_DEFAULT_LOGGER
+                     end
+
+      Ratchetio.configure do |config|
+        config.logger = rails_logger
+        config.environment = defined?(::Rails.env) && ::Rails.env || defined?(RAILS_ENV) && RAILS_ENV
+        config.root = defined?(::Rails.root) && ::Rails.root || defined?(RAILS_ROOT) && RAILS_ROOT
+        config.framework = defined?(::Rails.version) && "Rails: #{::Rails.version}" || defined?(::Rails::VERSION::STRING) && "Rails: #{::Rails::VERSION::STRING}"
+      end
+    end
+  end
+end
+
+Ratchetio::Rails.initialize

data/lib/ratchetio/railtie.rb

@@ -0,0 +1,36 @@
+require 'ratchetio'
+require 'rails'
+
+module Ratchetio
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+    end
+
+    config.after_initialize do
+      Ratchetio.configure do |config|
+        config.logger ||= ::Rails.logger
+        config.environment ||= ::Rails.env
+        config.root ||= ::Rails.root
+        config.framework = "Rails: #{::Rails::VERSION::STRING}"
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        # lazily load action_controller methods
+        require 'ratchetio/rails/controller_methods'
+        include Ratchetio::Rails::ControllerMethods
+      end
+
+      if defined?(::ActionDispatch::DebugExceptions)
+        # rails 3.2.x
+        require 'ratchetio/rails/middleware/exception_catcher'
+        ::ActionDispatch::DebugExceptions.send(:include, Ratchetio::Rails::Middleware::ExceptionCatcher)
+      elsif defined?(::ActionDispatch::ShowExceptions)
+        # rails 3.0.x and 3.1.x
+        require 'ratchetio/rails/middleware/exception_catcher'
+        ::ActionDispatch::ShowExceptions.send(:include, Ratchetio::Rails::Middleware::ExceptionCatcher)
+      end
+
+    end
+  end
+end
+

data/lib/ratchetio/version.rb

@@ -0,0 +1,3 @@
+module Ratchetio
+  VERSION = "0.0.1"
+end

data/lib/ratchetio.rb

@@ -0,0 +1,122 @@
+require 'net/http'
+require 'socket'
+require 'uri'
+
+require 'ratchetio/version'
+require 'ratchetio/configuration'
+require 'ratchetio/railtie'
+
+module Ratchetio
+
+  class << self
+    attr_writer :configuration
+    
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def report_request_exception(env, exception, request_data)
+      data = base_data
+
+      # parse backtrace
+      frames = []
+      exception.backtrace.each { |frame|
+        # parse the line
+        match = frame.match(/(.*):(\d+)(?::in `([^']+)')?/)
+        frames.push({ :filename => match[1], :lineno => match[2].to_i, :method => match[3] })
+      }
+      # reverse so that the order is as ratchet expects
+      frames.reverse!
+      
+      data[:body] = {
+        :trace => {
+          :frames => frames,
+          :exception => {
+            :class => exception.class.name,
+            :message => exception.message
+          }
+        }
+      }
+
+      data[:server] = server_data
+      data[:request] = request_data
+      
+      payload = build_payload(data)
+      send_payload(payload)
+    end
+
+    def report_message()
+      # TODO
+    end
+
+  private
+
+    def logger
+      configuration.logger
+    end
+
+    def send_payload(payload)
+      logger.info "[Ratchet.io] Sending payload"
+
+      uri = URI.parse(configuration.endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = payload
+      response = http.request(request)
+
+      if respons.code == '200'
+        logger.info "[Ratchet.io] Success"
+      else
+        logger.warning "[Ratchet.io] Got unexpected status code from Ratchet.io api: " + response.code
+        logger.info "[Ratchet.io] Response:"
+        logger.info response.body
+      end
+    end
+
+    def build_payload(data)
+      payload = {
+        :access_token => configuration.access_token,
+        :data => data
+      }
+      ActiveSupport::JSON.encode(payload)
+    end
+
+    def base_data(level="error")
+      config = configuration
+      {
+        :timestamp => Time.now.to_i,
+        :environment => config.environment,
+        :level => level,
+        :language => "ruby",
+        :framework => config.framework,
+        :notifier => {
+          :name => "ratchetio-gem",
+          :version => VERSION
+        }
+      }
+    end
+
+    def server_data
+      config = configuration
+      data = {
+        :host => Socket.gethostname
+      }
+      if config.root
+        data[:root] = config.root.to_s
+      end
+      if config.branch
+        data[:branch] = config.branch
+      end
+      data
+    end
+
+    def request_data
+      {}
+    end
+  end
+end
+

data/ratchetio.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ratchetio/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Rue"]
+  gem.email         = ["brian@ratchet.io"]
+  gem.description   = %q{Official ruby gem for Ratchet.io}
+  gem.summary       = %q{Reports exceptions to Ratchet.io}
+  gem.homepage      = "https://ratchet.io/"
+
+  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.name          = "ratchetio"
+  gem.require_paths = ["lib"]
+  gem.version       = Ratchetio::VERSION
+
+  #gem.add_development_dependency "rspec", "~> 2.6"
+end

data/spec/ratchetio_spec.rb

@@ -0,0 +1,3 @@
+describe Ratchetio::Ratchet do
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ratchetio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Rue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies: []
+description: Official ruby gem for Ratchet.io
+email:
+- brian@ratchet.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ratchetio.rb
+- lib/ratchetio/configuration.rb
+- lib/ratchetio/rails.rb
+- lib/ratchetio/rails/controller_methods.rb
+- lib/ratchetio/rails/middleware/exception_catcher.rb
+- lib/ratchetio/railtie.rb
+- lib/ratchetio/version.rb
+- ratchetio.gemspec
+- spec/ratchetio_spec.rb
+homepage: https://ratchet.io/
+licenses: []
+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: Reports exceptions to Ratchet.io
+test_files:
+- spec/ratchetio_spec.rb