hato 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10fe52f50d0d3e9135999a5f4c52a2b7d419266f
-  data.tar.gz: 82c0ad38232cd128e4e3a834ee1f310fd2f66dcd
+  metadata.gz: ce9895dcdaf6ee77a09e2816cee3a20f5034194b
+  data.tar.gz: 2bb1f36ebcd0e3f717bb9fdd0be0e4ec8f307edb
 SHA512:
-  metadata.gz: b6b226505e06bcea7aa9c77e1e7e4f64d21ad562db087c898667b3e41bc9c4fb0575fdf19326d03e74924606e70853ca3f1ea62e25030366d99c5657a9c50929
-  data.tar.gz: d9cec8a303fa12785af2c13a62199c30eae69e0792810edd03620870201a1474b4c38a1b1ce7ac89ff765e7cfa4c1ade0bd02b1683bc0efd884d30efb0532dd5
+  metadata.gz: 47208c46f29d95adcf2a3ba59d1423d483945e47927f84e341ff10327832f2387763719c2f0d23a55b26c51b7491f54d34f7ce81cb2ccc56f9af05d9cc2ef6e6
+  data.tar.gz: 46e5c4c1a57c36a4b6ebb0b25807fba47975e22d54deb712f628a052e2a8e26d1d3106f912c5e07eb92830cea39f8d6e364e3d856be988730e72f3f15bd5945a

data/README.md

@@ -10,12 +10,26 @@ Launch Hato with `hato` command:
 $ hato -c config.rb
 ```
 
-Then, post your notification message:
+### Notification
+
+Post your notification message:
 
 ```
 $ curl -d 'message=test' -d 'tag=test' -d 'api_key=test' http://localhost:9699/notify
 ```
 
+### WebHook
+
+Hato supports GitHub/GitHub Enterprise-formatted webhook.
+
+```
+$ curl -d 'payload={...}' -d 'api_key=test' http://localhost:9699/webhook
+```
+
+The tag is automatically built from payload. For example, the tag for this repository will be `webhook.kentaro.hato`.
+
+Consult [the documentation](https://help.github.com/articles/post-receive-hooks) for the details of webhook.
+
 ## Configuration
 
 Hato provides DSLs for configuration.
@@ -28,22 +42,30 @@ Hato::Config.define do
   host    '0.0.0.0'
   port    9699
 
-  # test by exact string mathing
+  # exact string mathing
   tag 'test' do
-    plugin 'Plugin1' do
+    plugin 'AwesomePlugin' do
       key1 'value1'
       key2 'value2'
       key3 'value3'
     end
   end
 
-  # test by regexp matching
+  # regexp matching
   tag /^test2\.([^\.]+)\.([^\.]+)$/ do |matched1, matched2|
-    plugin 'Plugin2' do
+    plugin 'AwesomePlugin' do
       key1 matched1
       key2 matched2
     end
   end
+
+  # webhook
+  tag /^webhook\.([^\.]+)\.([^\.]+)$/ do |owner, repository|
+    plugin 'AwesomePlugin' do
+      key1 owner
+      key2 repository
+    end
+  end
 end
 ```
 
@@ -54,6 +76,7 @@ There have already been some plugins:
   * [Hato::Plugin::Ikachan](https://github.com/kentaro/hato-plugin-ikachan)
   * [Hato::Plugin::Mail](https://github.com/kentaro/hato-plugin-mail)
   * [Hato::Plugin::Hipchat](https://github.com/banyan/hato-plugin-hipchat)
+  * [Hato::Plugin::Twitter](https://github.com/kentaro/hato-plugin-twitter)
 
 You can easily extend Hato by creating your own plugins. See the source for detail. It's really easy.
 

data/hato.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "response_code_matchers"
 end
 

data/lib/hato/httpd.rb

@@ -36,7 +36,7 @@ module Hato
         'Hato https://github.com/kentaro/hato'
       end
 
-      post "/notify" do
+      post '/notify' do
         settings.observer.update(
           tag:     params[:tag],
           message: params[:message],
@@ -48,6 +48,40 @@ module Hato
           message: 'Successfully sent the message you notified to me.',
         )
       end
+
+      post '/webhook' do
+        payload = params[:payload]
+
+        if !payload
+          halt 400, JSON.dump(
+            status:  :error,
+            message: 'Missing mandatory parameter: `payload`',
+          )
+        end
+
+        owner      = payload['repository'] && payload['repository']['owner'] && payload['repository']['owner']['name']
+        repository = payload['repository'] && payload['repository']['name']
+
+        if owner && repository
+          tag = ['webhook', owner, repository].join('.')
+        else
+          halt 400, JSON.dump(
+            status:  :error,
+            message: 'Invalid JSON message: both `repository.owner.name` and `repository.name` are required',
+          )
+        end
+
+        settings.observer.update(
+          tag:     tag,
+          payload: payload,
+          logger:  logger,
+        )
+
+        JSON.dump(
+          status:  :success,
+          message: 'Successfully sent the message you notified to me.',
+        )
+      end
     end
   end
 end

data/lib/hato/version.rb

@@ -1,3 +1,3 @@
 module Hato
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/hato/httpd_spec.rb

@@ -6,18 +6,23 @@ require 'rack/test'
 describe Hato::Httpd do
   include Rack::Test::Methods
 
-  def app
+  let(:config) {
     config = Hato::Config.load(
       File.expand_path('../../../assets/config/test.rb', __FILE__)
     )
-    observer = Hato::Observer.new(config)
-    Hato::Httpd::App.set(:observer, observer)
-    Hato::Httpd::App.set(:api_key,  config.api_key)
-    Hato::Httpd::App.new
+  }
+
+  def app
+    @_app ||= -> {
+      observer = Hato::Observer.new(config)
+      Hato::Httpd::App.set(:observer, observer)
+      Hato::Httpd::App.set(:api_key,  config.api_key)
+      Hato::Httpd::App.new
+    }.call
   end
 
   describe 'index' do
-    it do
+    it 'should return response' do
       get '/'
       expect(last_response).to be_ok
       expect(last_response.body).to eq('Hato https://github.com/kentaro/hato')
@@ -25,16 +30,73 @@ describe Hato::Httpd do
   end
 
   describe 'notify' do
-    it 'success' do
-      post '/notify', {message: 'test', tag: 'test', api_key: 'test'}
-      expect(last_response).to be_ok
-      expect(last_response.body).to eq('{"status":"success","message":"Successfully sent the message you notified to me."}')
+    context 'success' do
+      context 'when api_key is set' do
+        it 'should be success with correct api_key' do
+          post '/notify', {message: 'test', tag: 'test', api_key: 'test'}
+          expect(last_response).to be_ok
+          expect(last_response.body).to eq('{"status":"success","message":"Successfully sent the message you notified to me."}')
+        end
+      end
+
+      context 'when api_key is not set' do
+        before { app.settings.api_key = nil            }
+        after  { app.settings.api_key = config.api_key }
+
+        it 'should be success without api_key' do
+          post '/notify', {message: 'test', tag: 'test'}
+          expect(last_response).to be_ok
+          expect(last_response.body).to eq('{"status":"success","message":"Successfully sent the message you notified to me."}')
+        end
+      end
     end
 
-    it 'error' do
-      post '/notify', {message: 'test', tag: 'test', api_key: 'wrong_key'}
-      expect(last_response).to be_forbidden
-      expect(last_response.body).to eq('{"status":"error","message":"API key is wrong. Confirm your API key setting of server/client."}')
+    context 'error' do
+      it 'should be error when api_key is wrong' do
+        post '/notify', {message: 'test', tag: 'test', api_key: 'wrong_key'}
+        expect(last_response).to be_forbidden
+        expect(last_response.body).to eq('{"status":"error","message":"API key is wrong. Confirm your API key setting of server/client."}')
+      end
+    end
+  end
+
+  describe 'webhook' do
+    context 'success' do
+      let(:payload) {
+        {
+          repository: {
+            name:  'hato',
+            owner: {
+              name: 'kentaro',
+            },
+          }
+        }
+      }
+      it 'should be success with correct payload' do
+        post '/webhook', payload: payload, api_key: 'test'
+        expect(last_response).to be_ok
+        expect(last_response.body).to eq('{"status":"success","message":"Successfully sent the message you notified to me."}')
+      end
+    end
+
+    context 'error' do
+      it 'should be error when payload is not passed' do
+        post '/webhook', api_key: 'test'
+        expect(last_response).to be_bad_request
+        expect(last_response.body).to eq('{"status":"error","message":"Missing mandatory parameter: `payload`"}')
+      end
+
+      it 'should be error when repository.name is not passed' do
+        post '/webhook', api_key: 'test', payload: {repository: {owner: {name: 'kentaro'}}}
+        expect(last_response).to be_bad_request
+        expect(last_response.body).to eq('{"status":"error","message":"Invalid JSON message: both `repository.owner.name` and `repository.name` are required"}')
+      end
+
+      it 'should be error when repository.owner.name is not passed' do
+        post '/webhook', api_key: 'test', payload: {repository: {name: 'hato'}}
+        expect(last_response).to be_bad_request
+        expect(last_response.body).to eq('{"status":"error","message":"Invalid JSON message: both `repository.owner.name` and `repository.name` are required"}')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hato
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kentaro Kuribayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: response_code_matchers
+  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