exception_notification-td 0.0.1.pre2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 592a064dbe40de85210df6e3c7c7312c73339be5
-  data.tar.gz: 2198d8c11f95c1d1585ac547ccfe97f0514d150f
+  metadata.gz: 5f6ce048d50ff328fa1db9553c6d4ec117a04a46
+  data.tar.gz: d88849b31e8506ff0b8b1f41b1187992351ea003
 SHA512:
-  metadata.gz: 3585e51101db121217774782867a7b9ad4709e3237a40a900effb0189843975c8e0ed66d49625f1ad5f96c337620783f18cc74990fa6cb415115aca421b1033c
-  data.tar.gz: 81934771ad7de9632f0da2e61c4c38039eed11f9f6f0982d78885ee86ad5577819f93abc60bc21463ba156f5f037bcdade8c328e7d61a2ee0b147c4db6eb27cf
+  metadata.gz: 21166728cfa441d4be39da1120d667e4e2025affdb943ec5a0722c38c1695fdcace934283f443fd211a98d2b41a1a7677d05b106fdef4e15dff7fe31453bba19
+  data.tar.gz: 5d9b2e1df003130d61b8353ab17d2e1cbd89c3f989cb42a991baf6df219ed45141bd205c071fe3c762102286ce85f5af222f17b1297126ff2ad1ed5707ead5ad

data/README.md

@@ -1,6 +1,6 @@
-# ExceptionNotification::Td
+# exception_notification-td
 
-TODO: Write a gem description
+[![wercker status](https://app.wercker.com/status/7d390b46fd0fcea4e4aabc10f1a1b240/m "wercker status")](https://app.wercker.com/project/bykey/7d390b46fd0fcea4e4aabc10f1a1b240)
 
 ## Installation
 
@@ -20,11 +20,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In Rails, first set up normal [td config](https://github.com/treasure-data/td-logger-ruby#configuration) and then:
+
+```ruby
+# in config/environments/#{env}.rb
+config.middleware.use ExceptionNotification::Rack,
+  td: {
+    table_name: "#{Rails.env}_exceptions",
+  }
+```
+
+In some other rack apps, you need to set more options:
+
+```ruby
+use ExceptionNotification::Rack,
+  td: {
+    table_name: "#{env}_exceptions",
+    database: "yourdb",
+    apikey: "deadbeaf12345678"
+  }
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/exception_notification-td/fork )
+1. Fork it ( https://github.com/udzura/exception_notification-td/fork )
 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`)

data/Rakefile

@@ -1,2 +1,12 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+desc 'Run test_unit based test'
+Rake::TestTask.new do |t|
+  # To run test for only one file (or file path pattern)
+  #  $ bundle exec rake test TEST=test/test_specified_path.rb
+  t.libs.concat ["test"]
+  t.test_files = Dir["test/**/test_*.rb"]
+  t.verbose = true
+  t.ruby_opts = ["-r .config"]
+end

data/exception_notification-td.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "test-unit", ">= 3"
   spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "test-unit-power_assert"
+  spec.add_development_dependency "rack"
 end

data/lib/exception_notification/td/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotification
   module Td
-    VERSION = "0.0.1.pre2"
+    VERSION = "0.1.0"
   end
 end

data/lib/exception_notifier/td_notifier.rb

@@ -19,6 +19,7 @@ module ExceptionNotifier
         TreasureData::Logger.open(@database, options)
       end
     end
+    attr_reader :table_name, :backtrace_limit, :custom_param_proc, :database
 
     def call(exception, options = {})
       TD.event.post(@table_name, exception_to_td_data(exception, options))
@@ -39,12 +40,17 @@ module ExceptionNotifier
 
     def exception_to_td_data(exception, options)
       backtrace = exception.backtrace ? exception.backtrace[0, @backtrace_limit] : []
+      environment = if defined?(Rails)
+                      Rails.env
+                    else
+                      ENV['RACK_ENV'] || 'development'
+                    end
       params = {
         class: exception.class.to_s,
         message: exception.message,
         backtrace: backtrace,
         hostname: (Socket.gethostname rescue nil),
-        environment: Rails.env,
+        environment: environment,
       }
       if request_klass && options[:env]
         request = request_klass.new(options[:env])

data/test/.config.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'test/unit/rr'
+require 'test/unit/power_assert'
+
+require 'exception_notification-td'

data/test/lib/exception_notifier/test_td_notifier.rb

@@ -0,0 +1,154 @@
+class TestTdNotifier < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_normal_setup
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      backtrace_limit: 100,
+      custom_param_proc: proc {|i| i[:foo] = "bar"; i },
+      apikey: 'deadbeaf19842015'
+    }
+
+    assert_equal notifier.table_name, 'sample_table'
+    assert_equal notifier.database,   'sample'
+    assert_equal notifier.backtrace_limit, 100
+    assert_equal notifier.custom_param_proc[{}], {foo: "bar"}
+
+    apikey = TreasureData::Logger.logger.instance_eval{ @client }.apikey
+    assert_equal apikey, "deadbeaf19842015"
+  end
+
+  def test_required_options
+    @options = {}
+    assert_raise_message /Please set table_name/ do
+      ExceptionNotifier::TdNotifier.new(@options)
+    end
+
+    @options[:table_name] = "ganbaruzoi"
+    assert_raise_message /Please set database/ do
+      ExceptionNotifier::TdNotifier.new(@options)
+    end
+  end
+
+  def test_post_message
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      test_mode: true,
+      apikey: 'deadbeaf19842015'
+    }
+
+    # Fill in backtrace
+    begin
+      @l = __LINE__; raise StandardError, "sample error"
+    rescue => e
+      notifier_with_test_mode.call(e, {})
+    end
+
+    posted = TD.logger.queue[0]
+    assert_equal posted[:class], "StandardError"
+    assert_equal posted[:message], "sample error"
+    assert_match %r|#{Regexp.quote __FILE__}:#{@l}|, posted[:backtrace][0]
+    assert_not_nil posted[:hostname]
+    assert_not_nil posted[:environment]
+  end
+
+  def test_request_log_via_rack_env
+    require 'rack/request'
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      test_mode: true,
+      apikey: 'deadbeaf19842015'
+    }
+    @env = {
+      "HTTP_HOST" => "example.udzura.jp:80",
+      "rack.url_scheme" => 'http',
+      "PATH_INFO" => "/hello.html",
+      "REQUEST_METHOD" => "GET",
+      "HTTP_COOKIE" => "foo=bar;buz=1234;",
+      "HTTP_REFERER" => "http://example.com",
+    }
+
+    notifier_with_test_mode.call(StandardError.new("sample error"), {env: @env})
+    posted = TD.logger.queue[0]
+
+    assert_equal posted[:request_url], "http://example.udzura.jp/hello.html"
+    assert_equal posted[:method], "GET"
+    assert_equal posted[:cookies], {"foo"=>"bar", "buz"=>"1234"}
+    assert_equal posted[:referer], "http://example.com"
+    # TODO: add request body assertion
+  end
+
+  def test_custom_param_proc
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      test_mode: true,
+      apikey: 'deadbeaf19842015',
+      custom_param_proc: proc {|info|
+        info[:hello] = "world"
+      }
+    }
+
+    notifier_with_test_mode.call(StandardError.new("sample error"), {env: @env})
+    posted = TD.logger.queue[0]
+
+    assert_equal posted[:hello], "world"
+  end
+
+  def test_backtrace_limit
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      test_mode: true,
+      apikey: 'deadbeaf19842015'
+    }
+
+    # Fill in backtrace
+    begin
+      raise StandardError, "sample error"
+    rescue => e
+      notifier_with_test_mode.call(e, {})
+    end
+
+    posted = TD.logger.queue[0]
+    assert_equal posted[:backtrace].size, 10
+
+    @notifier = nil
+    @options = {
+      table_name: 'sample_table',
+      database: 'sample',
+      test_mode: true,
+      apikey: 'deadbeaf19842015',
+      backtrace_limit: 5
+    }
+    begin
+      raise StandardError, "sample error 2"
+    rescue => e
+      notifier_with_test_mode.call(e, {})
+    end
+
+    posted = TD.logger.queue[0]
+    assert_equal posted[:backtrace].size, 5
+  end
+
+  private
+
+  def notifier
+    @notifier ||= ExceptionNotifier::TdNotifier.new(@options)
+  end
+
+  def notifier_with_test_mode
+    @notifier ||= begin
+                    n = ExceptionNotifier::TdNotifier.new(@options)
+                    TreasureData::Logger.open_test
+                    n
+                  end
+  end
+end

data/wercker.yml

@@ -0,0 +1,16 @@
+box: wercker/rvm
+build:
+    steps:
+        - rvm-use:
+            version: 2.1.5
+        - bundle-install
+        - script:
+            name: test-unit
+            code: bundle exec rake test
+
+        - rvm-use:
+            version: 2.0.0-p598
+        - bundle-install
+        - script:
+            name: test-unit
+            code: bundle exec rake test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-td
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre2
+  version: 0.1.0
 platform: ruby
 authors:
 - Uchio KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: td-logger
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Send exception info to TreasureData
 email:
 - udzura@udzura.jp
@@ -111,6 +153,9 @@ files:
 - lib/exception_notification/td.rb
 - lib/exception_notification/td/version.rb
 - lib/exception_notifier/td_notifier.rb
+- test/.config.rb
+- test/lib/exception_notifier/test_td_notifier.rb
+- wercker.yml
 homepage: https://github.com/udzura/exception_notification-td
 licenses:
 - MIT
@@ -126,13 +171,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Send exception info to TreasureData
-test_files: []
+test_files:
+- test/.config.rb
+- test/lib/exception_notifier/test_td_notifier.rb