exception_notification-hato_notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b028d1832fd30775f54a28a0da29c6c0c6140ac
+  data.tar.gz: 74a2002c31177261b0e67c0bcf28510361cfaa8b
+SHA512:
+  metadata.gz: 7c73ea662fcdc7e723e9cc6ee8977a3298f20e85bbc40b73a366c80804ffd76c49de7b40e3eeef80bd107a108d42ef79bacee9e2d414eabd606b08176c03b2f3
+  data.tar.gz: 205c77ddb48b8937112e9f3faf0520bf651ebb06ec20a40499a781bd1bb2f3041f26f95888e93f991c1f281a3c5ae3cb33248c56eda461be6381cca28991a46d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kentaro Kuribayashi
+
+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,49 @@
+# exception_notification-hato_notifier [![](https://travis-ci.org/kentaro/exception_notification-hato_notifier.png)](http://travis-ci.org/kentaro/exception_notification-hato_notifier)
+
+`ExceptionNotifier::HatoNotifier` is a custom notifier for [Exception Notification](http://smartinez87.github.io/exception_notification/). It sends exception notification via [Hato](https://github.com/kentaro/hato).
+
+## Usage
+
+As other exception notifiers, add settings at the environments:
+
+  * `host` is the host of Hato server
+  * `port` is the port of the server (optional, default is `9699`)
+  * `api_key` is to set the API key if the server requires it (optional)
+  * `template` is to set templates for tag and message to be sent to Hato
+
+### Example
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  hato: {
+    host:     'localhost',
+    port:     9699,
+    api_key:  'YOUR API KEY',
+    template: {
+        tag:     ->(exception, options) { "exception.#{exception.class}" },
+        message: ->(exception, options) { "Exception: #{exception.class}: #{exception.message}" },
+    },
+  }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_notification-hato_notifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_notification-hato_notifier
+
+## 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,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec

data/exception_notification-hato_nitifier.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_notifier/hato_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'exception_notification-hato_notifier'
+  spec.version       = ExceptionNotifier::HatoNotifier::VERSION
+  spec.authors       = ['Kentaro Kuribayashi']
+  spec.email         = ['kentarok@gmail.com']
+  spec.description   = %q{Custom notifier for ExceptionNotification to send notification via Hato}
+  spec.summary       = %q{Custom notifier for ExceptionNotification to send notification via Hato}
+  spec.homepage      = 'https://github.com/kentaro/exception_notification-hato'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'webmock'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/exception_notifier/hato_notifier.rb

@@ -0,0 +1,84 @@
+module ExceptionNotifier
+  class HatoNotifier
+    class ConfigurationError < Exception; end
+
+    attr_reader :logger
+
+    def initialize(options)
+      template = options.delete(:template)
+      raise ConfigurationError.new('`template` key must be set') unless template
+
+      @tag_template     = template.delete(:tag)
+      @message_template = template.delete(:message)
+
+      if !@tag_template || !@message_template
+        raise ConfigurationError.new('Both `templlate.message` and `templlate.message` keys must be set')
+      end
+
+      @logger = Logger.new(
+        host:    options.delete(:host),
+        port:    options.delete(:port),
+        api_key: options.delete(:api_key),
+      )
+    end
+
+    def call(exception, options = {})
+      tag     = Query.build(@tag_template, exception, options)
+      message = Query.build(@message_template, exception, options)
+
+      logger.post(tag, message)
+    end
+
+    class Logger
+      require 'uri'
+      require 'net/http'
+
+      def initialize(settings)
+        @host    = settings.delete(:host)
+        @port    = settings.delete(:port) || 9699
+        @api_key = settings.delete(:api_key)
+      end
+
+      def post(tag, message)
+        client = Net::HTTP.new(@host, @port)
+        req    = Net::HTTP::Post.new('/notify')
+
+        req.form_data = { tag: tag, message: message }
+        req.form_data.merge!(api_key: api_key) if @api_key
+
+        client.request(req)
+      end
+    end
+
+    class Query
+      def initialize(template, exception, options = {})
+        @exception = exception
+        @options   = options
+        @template  = template
+      end
+
+      def build
+        expand_object(@template)
+      end
+
+      def self.build(template, exception, options = {})
+        self.new(template, exception, options).build
+      end
+
+      private
+
+      def expand_object(obj)
+        case obj
+        when Proc
+          expand_proc(obj)
+        else
+          obj
+        end
+      end
+
+      def expand_proc(prok)
+        expand_object(prok.call(@exception, @options))
+      end
+    end
+  end
+end

data/lib/exception_notifier/hato_notifier/version.rb

@@ -0,0 +1,5 @@
+module ExceptionNotifier
+  class HatoNotifier
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/exception_notifier/hato_notifier_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../../spec_helper'
+
+describe ExceptionNotifier::HatoNotifier do
+  class FooException < Exception; end
+
+  let(:exception) do
+    FooException.new('bar message')
+  end
+
+  let(:notifier) do
+    ExceptionNotifier::HatoNotifier.new(
+      host:    'localhost',
+      port:    9699,
+      api_key: 'test',
+      template: {
+        tag:     ->(exception, options) { "exception.#{exception.class}" },
+        message: ->(exception, options) { "Exception: #{exception.class}: #{exception.message}" },
+      }
+    )
+  end
+
+  describe '#call' do
+    context 'success' do
+      before do
+        stub_request(:any, 'localhost').to_return(
+          status: 200,
+          body: %q{"status":"success","message":"Successfully sent the message you notified to me."},
+        )
+      end
+
+      it 'logs valid data' do
+        expect(notifier.logger).to receive(:post).with(
+          'exception.FooException',
+          'Exception: FooException: bar message',
+        )
+        notifier.call(FooException.new('bar message'))
+      end
+    end
+  end
+
+  describe ExceptionNotifier::HatoNotifier::Query do
+    subject do
+      ExceptionNotifier::HatoNotifier::Query.build(template, exception, {})
+    end
+
+    context 'with String' do
+      let(:template) do
+        'string'
+      end
+
+      it 'returns string without any change' do
+        should == 'string'
+      end
+    end
+
+    context 'with Proc' do
+      let(:template) do
+        ->(e, opts) { "Exception: #{e.class}: #{e.message}" }
+      end
+
+      it 'returns intended string' do
+        should == 'Exception: FooException: bar message'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/exception_notifier/hato_notifier'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification-hato_notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Custom notifier for ExceptionNotification to send notification via Hato
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exception_notification-hato_nitifier.gemspec
+- lib/exception_notifier/hato_notifier.rb
+- lib/exception_notifier/hato_notifier/version.rb
+- spec/lib/exception_notifier/hato_notifier_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kentaro/exception_notification-hato
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Custom notifier for ExceptionNotification to send notification via Hato
+test_files:
+- spec/lib/exception_notifier/hato_notifier_spec.rb
+- spec/spec_helper.rb