ht_retro 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/ht_retro.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+gem "hoptoad_notifier"
+require "ht_retro/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ht_retro"
+  s.version     = Hoptoad::Retro::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jake Varghese"]
+  s.email       = ["jake@flvorful.com"]
+  s.homepage    = ""
+  s.summary     = %q{HT retro}
+  s.description = %q{if you need it you will know :)}
+
+  s.rubyforge_project = "ht_retro"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency "rails", "~> 3.0.6"
+  s.add_dependency "hoptoad_notifier", "~> 2.3"
+  s.add_development_dependency 'rspec', '~> 2.5'
+  
+end

data/lib/ht_retro/version.rb

@@ -0,0 +1,5 @@
+module Hoptoad
+  module Retro
+    VERSION = "0.0.1"
+  end
+end

data/lib/ht_retro.rb

@@ -0,0 +1,155 @@
+module HoptoadNotifier
+  HEADERS = {
+    "X-Hoptoad-Client-Name"    =>"Hoptoad Notifier", 
+    "Content-type"             =>"application/x-yaml", 
+    "X-Hoptoad-Client-Version" =>"1.2.4", 
+    "Accept"                   =>"text/xml, application/xml"
+  }
+  
+  class Sender
+    NOTICES_URI = '/notices/'.freeze
+  end
+  
+  class << self
+    
+    def notify_or_ignore(exception, opts = {})
+      #debugger
+      notice = build_notice_for(exception, opts)
+      send_notice(notice) if configuration.public?
+    end
+
+
+    private
+
+    def default_notice_options #:nodoc:
+      {
+        :api_key       => HoptoadNotifier.configuration.api_key,
+        :error_message => 'Notification',
+        :backtrace     => caller,
+        :request       => {},
+        :session       => {},
+        :environment   => ENV.to_hash
+      }
+    end
+
+    def send_notice(notice)
+      if configuration.public?
+        sender.send_to_hoptoad(notice)
+      end
+    end
+
+    def build_notice_for(exception, opts = {})
+      notice = normalize_notice(exception)
+      notice = clean_notice(notice)
+      notice = yamlize_notice(notice)
+    end
+    
+    def yamlize_notice(notice)
+      notice.stringify_keys.to_yaml
+    end
+
+
+    def normalize_notice(notice) #:nodoc:
+      case notice
+      when Hash
+        default_notice_options.merge(notice)
+      when Exception
+        default_notice_options.merge(exception_to_data(notice))
+      end
+    end
+
+    def clean_notice(notice) 
+      notice[:backtrace] = clean_hoptoad_backtrace(notice[:backtrace])
+      if notice[:request].is_a?(Hash) && notice[:request][:params].is_a?(Hash)
+        notice[:request][:params] = filter_parameters(notice[:request][:params]) if respond_to?(:filter_parameters)
+        notice[:request][:params] = clean_hoptoad_params(notice[:request][:params])
+      end
+      if notice[:environment].is_a?(Hash)
+        notice[:environment] = filter_parameters(notice[:environment]) if respond_to?(:filter_parameters)
+        notice[:environment] = clean_hoptoad_environment(notice[:environment])
+      end
+      {:notice => clean_non_serializable_data(notice)}
+    end
+
+    def exception_to_data(exception)
+      data = {
+        :api_key       => HoptoadNotifier.configuration.api_key,
+        :error_class   => exception.class.name,
+        :error_message => "#{exception.class.name}: #{exception.message}",
+        :backtrace     => exception.backtrace,
+        :environment   => ENV.to_hash
+      }
+
+      if self.respond_to? :request
+        data[:request] = {
+          :params      => request.parameters.to_hash,
+          :rails_root  => File.expand_path(RAILS_ROOT),
+          :url         => "#{request.protocol}#{request.host}#{request.request_uri}"
+        }
+        data[:environment].merge!(request.env.to_hash)
+      end
+
+      if self.respond_to? :session
+        data[:session] = {
+          :key         => session.instance_variable_get("@session_id"),
+          :data        => session.respond_to?(:to_hash) ?
+          session.to_hash :
+          session.instance_variable_get("@data")
+        }
+      end
+
+      data
+    end
+
+    def clean_hoptoad_backtrace backtrace #:nodoc:
+      if backtrace.to_a.size == 1
+        backtrace = backtrace.to_a.first.split(/\n\s*/)
+      end
+
+      filtered = backtrace.to_a.map do |line|
+        HoptoadNotifier.configuration.backtrace_filters.inject(line) do |line, proc|
+          proc.call(line)
+        end
+      end
+
+      filtered.compact
+    end
+
+    def clean_hoptoad_params params #:nodoc:
+      params.each do |k, v|
+        params[k] = "[FILTERED]" if HoptoadNotifier.configuration.params_filters.any? do |filter|
+          k.to_s.match(/#{filter}/)
+        end
+      end
+    end
+
+    def clean_hoptoad_environment env #:nodoc:
+      env.each do |k, v|
+        env[k] = "[FILTERED]" if HoptoadNotifier.configuration.environment_filters.any? do |filter|
+          k.to_s.match(/#{filter}/)
+        end
+      end
+    end
+
+    def clean_non_serializable_data(data) #:nodoc:
+      case data
+      when Hash
+        data.inject({}) do |result, (key, value)|
+          result.update(key => clean_non_serializable_data(value))
+        end
+      when Fixnum, Array, String, Bignum
+        data
+      else
+        data.to_s
+      end
+    end
+
+    def stringify_keys(hash) #:nodoc:
+      hash.inject({}) do |h, pair|
+        h[pair.first.to_s] = pair.last.is_a?(Hash) ? stringify_keys(pair.last) : pair.last
+        h
+      end
+    end
+  end
+end
+

data/spec/ht_retro_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe HoptoadNotifier do
+  describe '.notify_or_ignore' do
+    
+    context 'with an exception' do
+      let(:api_url) { HoptoadNotifier::Sender.new(HoptoadNotifier.configuration).instance_eval { url }.to_s }
+      let(:build_notice) { HoptoadNotifier.instance_eval { build_notice_for(Exception.new("blah blah")) } }
+      
+
+      it 'should send to the old url of /notices/' do
+        api_url.should match(/notices\//)
+      end
+      
+      it "should not send to the new api url" do
+        api_url.should_not match(/notices_api/)
+      end
+      
+      it "should send data to url in yaml form" do
+        build_notice.should match(/\-\-\-/)
+      end
+      
+      it "should not send data xml form" do
+        build_notice.should_not match(/^\</)
+      end
+      
+      it "should set headers to yaml content type" do
+        HoptoadNotifier::HEADERS["Content-type"].should match(/yaml/)
+      end
+
+      it "should not set headers to xml content type" do
+        HoptoadNotifier::HEADERS["Content-type"].should_not match(/xml/)
+      end
+
+      it "the root of the notice should be 'notice'" do
+        HoptoadNotifier.instance_eval do 
+          clean_notice(normalize_notice(Exception.new("blah blah"))) 
+        end.keys.should == [:notice]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'hoptoad_retro.rb'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: ht_retro
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jake Varghese
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 3
+        - 0
+        - 6
+        version: 3.0.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoptoad_notifier
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id003
+description: if you need it you will know :)
+email: 
+- jake@flvorful.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- ht_retro.gemspec
+- lib/ht_retro.rb
+- lib/ht_retro/version.rb
+- spec/ht_retro_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ht_retro
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: HT retro
+test_files: 
+- spec/ht_retro_spec.rb
+- spec/spec_helper.rb