exception_notification-ikachan 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d36d1fcfabd7fab2c2fd82a5ac0bcf93bc9ac8f7
-  data.tar.gz: 322666c6c4a3b7c7ab4e2d2938a38163ab1a2719
+  metadata.gz: 174d70e10eacc6df6566279d6eed3f8f7cb7aae5
+  data.tar.gz: 83a1c7f985f431272dadf45ce13196d490a6e1b0
 SHA512:
-  metadata.gz: 207b882420e3f7562c28a98cb464b1e6fba2b69342f4cab8ea60b6c91545572d66c7e7a04e4163ddc0bd4ba162a007c639a035e58e44c23cf6d6b207dd16a524
-  data.tar.gz: ea8f7a77c755159f3a13f3d34c355db759cfd618855e3f03ed75e799fdfaa0ae8021d5bf8946e003f1da15db41d6d54d053461456b24428f7fea0192d080c80f
+  metadata.gz: f58b929cca9b113f786485fb9b87eb95174a27dedb0ad045014d16b6c0b6ecd2bbdb25abb661d58fa1b018444afc4537ecb7b6d794a9aa62861917ad8f8ab6b6
+  data.tar.gz: 7104a68e2760be7033df27d9b85ad5a710e59ea78982ef9fa9e037ca25f8bd441ff7b4346da47af81d79d3497d031c21a6db002113e43ee6d71876eeabcc4260

data/README.md

@@ -1,6 +1,8 @@
 # ExceptionNotification::Ikachan
 
-ExceptionNotification  plugin for Ikachan!!!
+ExceptionNotification plugin for Ikachan!!!
+
+[![wercker status](https://app.wercker.com/status/6e059ec136a619b280a4f5b05e4a685b/m "wercker status")](https://app.wercker.com/project/bykey/6e059ec136a619b280a4f5b05e4a685b)
 
 ## Installation
 
@@ -30,6 +32,26 @@ end
 
 `:message_format` like `"%{class}: %{message}"` also available.
 
+### Message modifiers
+
+* `:message_prefix` - Adds prefix to default format
+* `:message_suffix` - Adds suffix to default format
+* `:message_nocolor` - Decolorize the format
+
+## Keys available in `:message_format`
+
+* `%{class}` - Exception class
+* `%{messgae}` - Exception message
+* `%{occurred}` - A line that the exception is first thrown (`exception.backtrace.first`)
+
+### Request keys
+
+Nofitier can notify the information via web requests.
+Keys named like `'%{request_path_info}', %{request_url}'` will be
+converted to descriptions from `request.path_info, request.url`, and so on.
+
+`request` should be an instance of `ActionDispatch::Request` (Rails) or `Rack::Request` (Other Rack apps)
+
 ## Contributing
 
 1. Fork it

data/exception_notification-ikachan.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rack"
 end

data/lib/exception_notification/ikachan/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotification
   class Ikachan
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/exception_notifier/ikachan_notifier.rb

@@ -40,26 +40,60 @@ module ExceptionNotifier
       @channels = channel.is_a?(Array) ? channel : [channel]
       @client   = Client.new(options[:base_url])
       @message_format = build_message_format(options)
-    end
-    attr_reader :client, :channels, :message_format
+      @message  = nil
 
-    def call(exception, options = {})
-      client.notice_all(channels, build_message(exception))
+      @request_param_names = message_format.scan(/%{(request_[a-zA-Z_?!]+)}/).flatten.uniq
+      @request_param_names.map{|n| [n, n.sub(/^request_/, '')] }.each do |param_name, attribute|
+        raise "Parameter name #{param_name} is unavailable" unless request_klass.method_defined?(attribute)
+      end
     end
+    attr_reader :client, :channels, :message_format, :message
+    DEFAULT_FORMAT = "\x02\x0315,4[ERROR]\x03 \x0313%{class}\x03 - %{message}\x03\x0f, %{occurred}"
+    IRC_SEQUENCE_RE = Regexp.new("[\x02\x03\x0f](\\d+)?(,\\d+)?")
 
-    private
-    def build_message_format(options)
-      return options[:message_format] if options[:message_format]
-      "\x02\x0315,4[ERROR]\x03 \x0313%{class}\x03 - \x038%{message}\x03, %{occurred}\x0f"
+    def call(exception, options = {})
+      build_message(exception, options)
+      client.notice_all(channels, message)
     end
 
-    def build_message(exception)
+    def build_message(exception, options = {})
       params = {
         class:    exception.class,
         message:  exception.message,
         occurred: (exception.backtrace.first rescue nil),
       }
-      return message_format % params
+      params.merge!(build_params_from_request(options[:env])) if options[:env]
+      @message = message_format % params
+    end
+
+    private
+    def request_klass
+      @request_klass ||= if defined?(ActionDispatch::Request)
+        ActionDispatch::Request
+      else
+        require 'rack/request'
+        Rack::Request
+      end
+    rescue LoadError, NameError
+      raise "Please use this notifier in some kind of Rack-based webapp"
+    end
+
+    def build_message_format(options)
+      return options[:message_format] if options[:message_format]
+      DEFAULT_FORMAT.dup.tap do |fmt|
+        fmt.prepend(options[:message_prefix]) if options[:message_prefix]
+        fmt.concat(options[:message_suffix])  if options[:message_suffix]
+        fmt.gsub!(IRC_SEQUENCE_RE, '')        if options[:message_nocolor]
+      end
+    end
+
+    def build_params_from_request(env)
+      request = request_klass.new(env)
+      dest = {}
+      @request_param_names.map{|n| [n, n.sub(/^request_/, '')] }.each do |param_name, attribute|
+        dest[param_name.to_sym] = request.send(attribute)
+      end
+      dest
     end
 
     # alias

data/spec/exception_notification/ikachan_spec.rb

@@ -17,6 +17,104 @@ describe ExceptionNotifier::IkachanNotifier do
         expect(notifier.client.base_url).to eq("http://ikachan.udzura.jp/")
       end
     end
+
+    describe "message with invalid request key" do
+      let(:options) do
+        {
+          base_url: 'ikachan.udzura.jp',
+          channel:  '#udzura',
+          message_format: '%{request_noattr}'
+        }
+      end
+
+      it "should just raise error" do
+        expect {
+          notifier
+        }.to raise_error(RuntimeError, "Parameter name request_noattr is unavailable")
+      end
+    end
+  end
+
+  describe "#build_message and #message" do
+    before do
+      require 'rack/request'
+      stub_request(:post, "http://ikachan.udzura.jp/join")
+      stub_request(:post, "http://ikachan.udzura.jp/notice")
+    end
+    let(:exception) { StandardError.new("Hello, exception!")}
+
+    let(:options) do
+      {
+        base_url: 'ikachan.udzura.jp',
+        channel:  '#udzura',
+      }.merge(extra_options)
+    end
+
+    describe "message with request info" do
+      let(:extra_options) do
+        {message_format: '%{request_path_info}'}
+      end
+
+      it "should include request's path info" do
+        notifier.build_message(exception, {env: {'PATH_INFO' => '/foo/bar'}})
+        expect(notifier.message).to eq("/foo/bar")
+      end
+    end
+
+    describe "message with more request info" do
+      let(:env_sane) do
+        {"HTTP_HOST" => "example.udzura.jp:80", "rack.url_scheme" => 'http', "PATH_INFO" => "/hello.html"}
+      end
+      let(:extra_options) do
+        {message_format: '%{request_url} / ssl? = %{request_ssl?}'}
+      end
+
+      it do
+        notifier.build_message(exception, {env: env_sane})
+        expect(notifier.message).to eq("http://example.udzura.jp/hello.html / ssl? = false")
+      end
+    end
+
+    describe "message modifiers" do
+      before { notifier.build_message(exception, {env: {'PATH_INFO' => '/foo/bar'}}) }
+      let(:default_message) do
+        ExceptionNotifier::IkachanNotifier::DEFAULT_FORMAT % {
+          class: "StandardError",
+          message: "Hello, exception!",
+          occurred: ''
+        }
+      end
+
+      describe ':message_prefix' do
+        let(:extra_options) do
+          { message_prefix: 'hello - ' }
+        end
+
+        it do
+          expect(notifier.message).to eq('hello - ' + default_message)
+        end
+      end
+
+      describe ':message_suffix' do
+        let(:extra_options) do
+          { message_suffix: ' - world' }
+        end
+
+        it do
+          expect(notifier.message).to eq(default_message + ' - world')
+        end
+      end
+
+      describe ':message_nocolor' do
+        let(:extra_options) do
+          { message_nocolor: true }
+        end
+
+        it do
+          expect(notifier.message).to eq("[ERROR] StandardError - Hello, exception!, ")
+        end
+      end
+    end
   end
 
   describe "#call" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-ikachan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Uchio KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exception_notification
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !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: ExceptionNotification ikachan plugin
 email:
 - udzura@paperboy.co.jp