hato 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51d1a23f2c7c13c67eb66e3de4f90028df29da6b
+  data.tar.gz: 3e98e5f54c6afb3d289efe803cf4fb368e81f818
+SHA512:
+  metadata.gz: 53d3879360b6c5ed8be4105e678985612ee905bae151a2417a7ade8b5174c7ee2e82f519b90445edfab582bf6635f03a38bca87832273fc2208a41e44b0a07dd
+  data.tar.gz: b4d4793abd6db91892b1241d628968a1b95adc3433ed7d69a293b21161d4cbe3673d476bbebb4ba4e2375f2efa2ddbe777ffc648dc24d7def897b6a8a936d518

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-19mode
+  - jruby-19mode
+  - jruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+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,114 @@
+# Hato [![BuildStatus](https://secure.travis-ci.org/kentaro/hato.png)](http://travis-ci.org/kentaro/hato)
+
+Hato is a tool to manage notification methods. Once you configure notification methods, you can send notifications via the methods just by posting message to this tool.
+
+## Usage
+
+Launch Hato with `hato` command:
+
+```
+$ hato -c config.rb
+```
+
+Then, post your notification message:
+
+```
+$ curl -d 'message=test' -d 'tag=test' -d 'api_key=test' http://localhost:9699/notify
+```
+
+## Configuration
+
+Hato provides DSLs for configuration.
+
+e.g. config.rb:
+
+```
+Hato::Config.define do
+  config.api_key = 'test'
+  config.host    = '0.0.0.0'
+  config.port    = 9699
+
+  tag 'test' do
+    plugin 'Ikachan' do
+      config.scheme  = 'http'
+      config.host    = 'irc.example.com'
+      config.port    = 4979
+      config.channel = 'hato'
+    end
+
+    plugin 'Mail' do
+      config.smtp = {
+        address:   'smtp.example.com',
+        port:      587,
+        domain:    'example',
+        user_name: 'hato',
+        password:  'password',
+        enable_ssl: true,
+      }
+
+      subject_template = <<EOS
+[<%= args[:tag] %>] Notification
+EOS
+      body_template = <<EOS
+You've got a message:
+
+<%= args[:message] %>
+EOS
+
+      config.message = {
+        from: 'hato@example.com',
+        to:   [
+          'foo@example.com',
+          'bar@example.com',
+        ],
+        subject_template: subject_template,
+        body_template:    body_template,
+      }
+    end
+  end
+end
+```
+
+## Plugin Architecture
+
+Hato bundles several plugins by default:
+
+  * [Hato::Plugin::Ikachan](lib/hato/plugin/ikachan.rb)
+  * [Hato::Plugin::Mail](lib/hato/plugin/mail.rb)
+
+You can easily extend Hato by creating your own plugins. See the source for detail. It's really easy.
+
+## Using Hato with Thrid-party Plugins
+
+At first, create a `Gemfile` to manage dependencies:
+
+```
+source 'https://rubygems.org'
+
+gem 'hato'
+gem 'hato/plugin/awesome_plugin'
+```
+
+Then, execute `bundle exec hato -c your_config_file`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hato'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hato
+
+## 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/bin/hato

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'hato'
+
+opts = {}
+
+parser = OptionParser.new
+parser.on('-c=VAL', '--config=VAL') { |v| opts[:config_file] = v }
+parser.parse!(ARGV)
+
+Hato.run(opts)

data/hato.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hato/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hato"
+  spec.version       = Hato::VERSION
+  spec.authors       = ["Kentaro Kuribayashi"]
+  spec.email         = ["kentarok@gmail.com"]
+  spec.description   = %q{A Notification Management Tools}
+  spec.summary       = %q{A Notification Management Tools}
+  spec.homepage      = "https://github.com/kentaro/hato"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.executables   = ["hato"]
+  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 "sinatra"
+  spec.add_dependency "sinatra-logger"
+  spec.add_dependency "mail"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/hato/config.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+require 'hashie'
+
+module Hato
+  module Config
+    module DSL
+      attr_accessor :name
+
+      def initialize(name, &block)
+        @name = name
+        instance_eval(&block)
+      end
+
+      def method_missing(method, *args)
+        config.send(method)
+      end
+
+      private
+
+      def config
+        @config ||= Hashie::Mash.new
+      end
+    end
+
+    extend DSL
+
+    def self.load(config_file)
+      Kernel.load(config_file)
+      @loaded = true
+      self
+    end
+
+    def self.loaded?
+      @loaded
+    end
+
+    def self.define(&block)
+      instance_eval(&block)
+    end
+
+    def self.tags
+      @tags ||= []
+    end
+
+    def self.tag(name, &block)
+      self.tags << Tag.new(name, &block)
+    end
+
+    def self.match(tag)
+      tags.select { |t| t.name == tag }
+    end
+
+    def self.reset
+      @loaded = false
+      @config = nil
+      @tags   = nil
+    end
+
+    class Tag
+      include DSL
+
+      def plugins
+        @plugins ||= []
+      end
+
+      def plugin(name, &block)
+        self.plugins << Plugin.new(name, &block)
+      end
+    end
+
+    class Plugin
+      include DSL
+    end
+  end
+end

data/lib/hato/httpd.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'sinatra'
+require 'sinatra/logger'
+
+module Hato
+  class Httpd
+    def initialize(observer, config)
+      @observer = observer
+      @config   = config
+    end
+
+    def run
+      App.set(:observer, @observer)
+      App.set(:api_key,  @config.api_key)
+
+      Rack::Handler::WEBrick.run(
+        App.new,
+        Host: @config.host || '0.0.0.0',
+        Port: @config.port || 9699,
+      )
+    end
+
+    class App < Sinatra::Base
+      enable :logging
+
+      before do
+        if settings.api_key != params[:api_key]
+          halt 403, JSON.dump(
+            status:  :error,
+            message: 'API key is wrong. Confirm your API key setting of server/client.',
+          )
+        end
+      end
+
+      post "/notify" do
+        settings.observer.update(
+          tag:     params[:tag],
+          message: params[:message],
+          logger:  logger,
+        )
+
+        JSON.dump(
+          status:  :success,
+          message: 'Successfully sent the message you notified to me.',
+        )
+      end
+    end
+  end
+end

data/lib/hato/observer.rb

@@ -0,0 +1,51 @@
+require 'hato/plugin'
+
+module Hato
+  class Observer
+    def initialize(config)
+      @config = config
+    end
+
+    def update(args)
+      logger  = args.delete(:logger)
+      plugins = load_plugins_for(args[:tag])
+
+      plugins.each do |plugin|
+        Thread.start(plugin) do |plugin|
+          begin
+            plugin.notify(args)
+          rescue => e
+            logger.error("#{e.message} from #{plugin.class}")
+          end
+        end
+      end
+    end
+
+    protected
+
+    def load_plugins_for(tag)
+      plugins = []
+
+      @config.match(tag).each do |matched|
+        matched.plugins.each do |plugin|
+          plugin_file_name = file_name_for(plugin.name)
+          require plugin_file_name
+
+          plugin_class = plugin_class_for(plugin.name)
+          plugins << plugin_class.new(plugin)
+        end
+      end
+
+      plugins
+    end
+
+    def plugin_class_for(name)
+      Hato::Plugin.const_get(name.to_s)
+    end
+
+    def file_name_for(name)
+      file_name = name.to_s.gsub(/[A-Z][a-z0-9_]+?/) { |s| "_#{s.downcase}" }
+      'hato/plugin/' + file_name.sub(/^_/, '')
+    end
+  end
+end

data/lib/hato/plugin/ikachan.rb

@@ -0,0 +1,33 @@
+require 'uri'
+require 'net/http'
+
+module Hato
+  module Plugin
+    class Ikachan < Base
+      def notify(args)
+        send_request(:join)
+        send_request(:notice, args[:message])
+      end
+
+      protected
+
+      def send_request(action, message='')
+        url = '%s://%s:%s/%s' % [
+          config.scheme || 'http',
+          config.host,
+          config.port   || 4979,
+          action.to_s,
+        ]
+
+        http = Net::HTTP.new(URI(url).host, URI(url).port)
+        req  = Net::HTTP::Post.new(URI(url).path)
+
+        req.form_data = {
+          'channel' => "##{config.channel}",
+          'message' => message,
+        }
+        http.request(req)
+      end
+    end
+  end
+end

data/lib/hato/plugin/mail.rb

@@ -0,0 +1,48 @@
+require 'erb'
+require 'mail'
+
+module Hato
+  module Plugin
+    class Mail < Base
+      def notify(args)
+        if smtp_opts = config.smtp
+          ::Mail.defaults do
+            delivery_method :smtp, (
+              smtp_opts.to_hash.keys.inject({}) { |opts, key|
+                opts[key.to_sym] = smtp_opts.send(key.to_sym)
+                opts
+              }
+            )
+          end
+        end
+
+        to_addresses = config.message['to']
+        if to_addresses.is_a?(String)
+          to_addresses = [to_addresses]
+        end
+
+        mail = {
+          from:    config.message['from'],
+          subject: render(config.message['subject_template'], args),
+          body:    render(config.message['body_template'], args),
+        }
+
+        to_addresses.each do |to_address|
+          ::Mail.deliver do
+            from    mail[:from]
+            to      to_address
+            subject mail[:subject]
+            body    mail[:body]
+          end
+        end
+      end
+
+      protected
+
+      def render(template, args)
+        erb = ERB.new(template)
+        erb.result(binding).chomp
+      end
+    end
+  end
+end

data/lib/hato/plugin.rb

@@ -0,0 +1,11 @@
+module Hato
+  module Plugin
+    class Base
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+    end
+  end
+end

data/lib/hato/version.rb

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

data/lib/hato.rb

@@ -0,0 +1,14 @@
+require 'hato/version'
+require 'hato/config'
+require 'hato/observer'
+require 'hato/httpd'
+
+module Hato
+  def self.run(opts = {})
+    config   = Config.load(opts[:config_file])
+    observer = Observer.new(config)
+    server   = Httpd.new(observer, config)
+
+    server.run
+  end
+end

data/spec/assets/config/test.rb

@@ -0,0 +1,44 @@
+Hato::Config.define do
+  config.api_key = 'test'
+  config.host    = '0.0.0.0'
+  config.port    = 9699
+
+  tag 'test' do
+    plugin 'Ikachan' do
+      config.scheme  = 'http'
+      config.host    = 'irc.example.com'
+      config.port    = 4979
+      config.channel = 'hato'
+    end
+
+    plugin 'Mail' do
+      config.smtp = {
+        address:   'smtp.example.com',
+        port:      587,
+        domain:    'example',
+        user_name: 'hato',
+        password:  'password',
+        enable_ssl: true,
+      }
+
+      subject_template = <<EOS
+[<%= args[:tag] %>] Notification
+EOS
+      body_template = <<EOS
+You've got a message:
+
+<%= args[:message] %>
+EOS
+
+      config.message = {
+        from: 'hato@example.com',
+        to:   [
+          'foo@example.com',
+          'bar@example.com',
+        ],
+        subject_template: subject_template,
+        body_template:    body_template,
+      }
+    end
+  end
+end

data/spec/lib/pigeon/config_spec.rb

@@ -0,0 +1,56 @@
+require_relative '../../spec_helper'
+
+describe Hato::Config do
+  before { described_class.reset }
+
+  describe '.load' do
+    context 'success' do
+      context 'when a config file is passed in' do
+        before {
+          described_class.load(
+            File.expand_path('../../../assets/config/test.rb', __FILE__)
+          )
+        }
+
+        it { expect(described_class.loaded?).to be_true }
+      end
+    end
+
+    context 'failure' do
+      context 'when a config file does not exist' do
+        it {
+          expect {
+            described_class.load('no such file')
+          }.to raise_error LoadError
+        }
+      end
+    end
+  end
+
+  describe '.define' do
+    context 'success' do
+      context 'when a config file is passed in' do
+        before {
+          described_class.load(
+            File.expand_path('../../../assets/config/test.rb', __FILE__)
+          )
+        }
+
+        it {
+          expect(described_class.api_key).to be == 'test'
+
+          expect(described_class.tags).to be_an_instance_of Array
+          expect(described_class.tags.size).to be == 1
+
+          tag = described_class.tags.first
+          expect(tag.plugins).to be_an_instance_of Array
+          expect(tag.plugins.size).to be == 2
+
+          plugin = tag.plugins.first
+          expect(plugin.name).to be == 'Ikachan'
+          expect(plugin.host).to be == 'irc.example.com'
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/hato'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: hato
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: sinatra-logger
+  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: mail
+  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: hashie
+  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'
+- !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'
+description: A Notification Management Tools
+email:
+- kentarok@gmail.com
+executables:
+- hato
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hato
+- hato.gemspec
+- lib/hato.rb
+- lib/hato/config.rb
+- lib/hato/httpd.rb
+- lib/hato/observer.rb
+- lib/hato/plugin.rb
+- lib/hato/plugin/ikachan.rb
+- lib/hato/plugin/mail.rb
+- lib/hato/version.rb
+- spec/assets/config/test.rb
+- spec/lib/pigeon/config_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kentaro/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: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: A Notification Management Tools
+test_files:
+- spec/assets/config/test.rb
+- spec/lib/pigeon/config_spec.rb
+- spec/spec_helper.rb