tumugi-plugin-webhook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bfa6d9f2a87159a2f6ffae0a07aa29e5ecf2466
+  data.tar.gz: 5137b0b4ccab9e6944eceb3ace1e01feb579e98b
+SHA512:
+  metadata.gz: b91705e5abc8cb2690d638ab7f2f4062873ba1cbc0abf3b0c4d518c238f57bf15e8d5ba98554b5bf272cca8b39d2d5c3965197ee9f2696c210653f8795ed0d75
+  data.tar.gz: a1653b0619d0b46f9fa9e7cffcca891eef1eee426623b41bc69cf8984d379061a86316cddaa0cd52353c1891b56291a62163b42d3ed6634e1f09676370b00c56

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+/.bundle/
+/Gemfile.lock
+/pkg/
+/tmp/
+.ruby-version

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1
+  - 2.3.1
+  - jruby-9.1.2.0
+before_install:
+  - gem install bundler
+

data/Gemfile

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

data/README.md

@@ -0,0 +1,57 @@
+[![Build Status](https://travis-ci.org/tumugi/tumugi-plugin-webhook.svg?branch=master)](https://travis-ci.org/tumugi/tumugi-plugin-webhook) [![Code Climate](https://codeclimate.com/github/tumugi/tumugi-plugin-webhook/badges/gpa.svg)](https://codeclimate.com/github/tumugi/tumugi-plugin-webhook) [![Coverage Status](https://coveralls.io/repos/github/tumugi/tumugi-plugin-webhook/badge.svg?branch=master)](https://coveralls.io/github/tumugi/tumugi-plugin-webhook)  [![Gem Version](https://badge.fury.io/rb/tumugi-plugin-webhook.svg)](https://badge.fury.io/rb/tumugi-plugin-webhook)
+
+# WebHook plugin for [tumugi](https://github.com/tumugi/tumugi)
+
+tumugi-plugin-webhook is a plugin for integrate various WebHooks and [tumugi](https://github.com/tumugi/tumugi).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tumugi-plugin-webhook'
+```
+
+And then execute `bundle install`.
+
+## Task
+
+### Tumugi::Plugin::WebhookTask
+
+`Tumugi::Plugin::WebhookTask` is a task to send a HTTP request for any WebHooks.
+
+#### Parameters
+
+- **url** WebHook URL (string, required)
+- **http_method** HTTP method (string, optional, default: "post")
+- **body** WebHook body (string or hash, optional, default: `nil`)
+- **body_encoding** WebHook body encoding type (string, optional, default: "json")
+  - "json": MIME type is `application/json`
+  - "url_encoded": MIME type is  `application/x-www-form-urlencoded`
+
+#### Example
+
+```rb
+task :main, type: :webhook do
+  url "http://httpbin.org/post"
+  body {
+    { text: "message" }
+  }
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then run `bundle exec rake test` to run the tests.
+
+Run this plugin with tumugi, run
+
+```
+$ bundle exec tumugi run -f examples/example.rb main
+```
+
+## License
+
+The gem is available as open source under the terms of the [Apache License
+Version 2.0](http://www.apache.org/licenses/).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/examples/example.rb

@@ -0,0 +1,6 @@
+task :main, type: :webhook do
+  url "http://httpbin.org/post"
+  body {
+    { text: "message" }
+  }
+end

data/lib/tumugi/plugin/task/webhook.rb

@@ -0,0 +1,62 @@
+require 'tumugi'
+require 'faraday'
+require 'faraday_middleware'
+require 'uri'
+require_relative '../webhook/logger'
+
+module Tumugi
+  module Plugin
+    class WebhookTask < Tumugi::Task
+      Tumugi::Plugin.register_task('webhook', self)
+
+      METHODS = Set.new [:get, :post, :put, :delete]
+      BODY_ENCODINGS = Set.new [ :url_encoded, :json ]
+
+      param :url, type: :string, required: true
+      param :http_method, type: :string, default: "post"
+      param :body, type: :string
+      param :body_encoding, type: :string, default: "json"
+
+      def run
+        validate_parameters!
+
+        conn = Faraday.new(url: url) do |c|
+          c.request :retry
+          c.request body_encoding.downcase.to_sym
+          c.response :follow_redirects
+          c.response :webhook_logger, logger
+          c.adapter Faraday.default_adapter
+        end
+
+        m = http_method.downcase.to_sym
+        http_body = [:get, :delete].include?(m) ? nil : body
+        begin
+          res = conn.run_request(m, nil, http_body, nil)
+          if !res.success?
+            raise Tumugi::TumugiError.new("#{m} #{url} failed: #{res.status} #{res.body}")
+          end
+        rescue => e
+          raise Tumugi::TumugiError.new("#{m} #{url} failed", e)
+        end
+
+        if _output && _output.is_a?(Tumugi::Plugin::FileSystemTarget)
+          _output.open("w") do |f|
+            f.write(res.body)
+          end
+        end
+      end
+
+      private
+
+      def validate_parameters!
+        if !METHODS.include?(http_method.downcase.to_sym)
+          raise Tumugi::TumugiError.new("Unsupported http method: #{http_method}")
+        end
+
+        if !BODY_ENCODINGS.include?(body_encoding.downcase.to_sym)
+          raise Tumugi::TumugiError.new("Unsupported body encoding: #{body_encoding}")
+        end
+      end
+    end
+  end
+end

data/lib/tumugi/plugin/webhook/logger.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'json'
+
+module Tumugi
+  module Plugin
+    module Webhook
+      class Logger < Faraday::Response::Middleware
+        attr_reader :logger
+
+        def initialize(app, logger)
+          super(app)
+          @logger = logger
+        end
+
+        def call(env)
+          logger.info { "#{env[:method].upcase} #{env[:url]}" }
+          log_request(env)
+          super
+        end
+
+        def on_complete(env)
+          status = env[:status]
+          log_response_status(status) { "HTTP #{status}" }
+          log_response(env)
+        end
+
+        def log_request(env)
+          log(env[:request_headers], env[:body])
+        end
+
+        def log_response(env)
+          log(env[:response_headers], env[:body])
+        end
+
+        def log(headers, body)
+          logger.debug {
+            JSON.generate(
+              headers: headers,
+              body: body
+            )
+          }
+        end
+
+        def log_response_status(status, &block)
+          case status
+          when 200..399
+            logger.info(&block)
+          else
+            logger.error(&block)
+          end
+        end
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware({
+  webhook_logger: Tumugi::Plugin::Webhook::Logger
+})

data/tumugi-plugin-webhook.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "tumugi-plugin-webhook"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Kazuyuki Honda"]
+  spec.email         = ["hakobera@gmail.com"]
+
+  spec.summary       = "WebHook plugin for tumugi"
+  spec.homepage      = "https://github.com/hakobera/tumugi-plugin-webhook"
+  spec.license       = "Apache License Version 2.0"
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "tumugi", ">= 0.6.3"
+  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: tumugi-plugin-webhook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuyuki Honda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tumugi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  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: coveralls
+  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: 
+email:
+- hakobera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/tumugi/plugin/task/webhook.rb
+- lib/tumugi/plugin/webhook/logger.rb
+- tumugi-plugin-webhook.gemspec
+homepage: https://github.com/hakobera/tumugi-plugin-webhook
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: WebHook plugin for tumugi
+test_files: []