reactio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36606269241ac620fd46cec36ca3cf045e3b8908
+  data.tar.gz: 85c450f2de769ae85546cb9031cedd4671cb90a8
+SHA512:
+  metadata.gz: fe2eadf9a63c611c44cf8bd41665f20b706684f1c69e2d84ffacd777556d189f247c4b9c90f292f40c7580ac76676a94626756c6f32382df2b9236a8898c6855
+  data.tar.gz: 8e3e02366a1851008c23b279145b2b47c3fadabe19a4d3aa615007fc11756f295609da0645d8232e555005277f9ffa74d70caa5b7650b09fdf354cde2a103ef8

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/vendor/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+.rspec
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hajime Sueyoshi
+
+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,118 @@
+# Reactio
+
+Reactio API Client for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reactio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reactio
+
+## Usage
+
+### include Reactio
+
+```ruby
+require 'reactio'
+include Reactio
+
+reactio.create_incident('An Incident')
+```
+
+And run:
+
+    $ REACTIO_API_KEY='YOUR_API_KEY' REACTIO_ORGANIZATION='YOUR_ORGANIZATION' bundle exec ruby create_incident.rb
+
+### Or instantiate Reactio::Service
+
+```ruby
+require 'reactio'
+
+reactio = Reactio::Service.new(
+  api_key: 'YOUR_API_KEY',
+  organization: 'YOUR_ORGANIZATION'
+)
+reactio.create_incident('An Incident')
+```
+
+### Reactio incidents
+
+- インシデント作成（およびトピック登録）
+
+```ruby
+require 'reactio'
+include Reactio
+
+reactio.create_incident(
+  'サイト閲覧不可',
+  status: 'open',
+  detection: 'internal',
+  cause: 'over-capacity',
+  cause_supplement: 'Webサーバがアクセス過多でダウン',
+  point: 'application',
+  scale: 'point',
+  pend_text: 'Webサーバの再起動を行う',
+  topics: %w(原因調査 復旧作業),
+  notification_text: '至急対応をお願いします',
+  notification_call: false
+)
+```
+
+- 一斉通知
+
+```ruby
+require 'reactio'
+include Reactio
+
+reactio.notify_incident(
+  123,
+  notification_text: '至急対応をお願いします',
+  notification_call: true
+)
+```
+
+- インシデント一覧取得
+
+```ruby
+require 'reactio'
+include Reactio
+
+list = reactio.list_incidents(
+  from: Time.now - (60 * 60 * 24 * 7),
+  to: Time.now,
+  status: 'pend',
+  page: 1,
+  per_page: 50
+)
+
+p list.first
+#=> {:id=>1, :name=>"サイト閲覧不可", :manager=>nil, :status=>"pend", :detection=>"msp", :cause=>"over-capacity", :cause_supplement=>"Webサーバがアクセス過多でダウン", :point=>"middleware", :scale=>"whole", :pend_text=>"Webサーバの再起動を行う", :close_text=>"Webサーバのスケールアウトを行う", :closed_by=>nil, :closed_at=>nil, :pended_by=>nil, :pended_at=>nil, :created_by=>0, :created_at=>1430208000, :updated_by=>0, :updated_at=>1430208000}
+```
+
+- インシデント取得
+
+```ruby
+require 'reactio'
+include Reactio
+
+p reactio.describe_incident(123)
+#=> {:id=>123, :name=>"サイト閲覧不可", :manager=>nil, :status=>"open", :detection=>"msp", :cause=>"over-capacity", :cause_supplement=>"Webサーバがアクセス過多でダウン", :point=>"middleware", :scale=>"whole", :pend_text=>"Webサーバの再起動を行う", :close_text=>"Webサーバのスケールアウトを行う", :closed_by=>nil, :closed_at=>nil, :pended_by=>nil, :pended_at=>nil, :created_by=>0, :created_at=>1430208000, :updated_by=>0, :updated_at=>1430208000, :topics=>[{:id=>1, :name=>"原因調査", :status=>"open", :color=>"#5661aa", :closed_by=>nil, :closed_at=>nil, :created_by=>0, :created_at=>1430208000, :updated_by=>0, :updated_at=>1430208000}, {:id=>2, :name=>"復旧作業", :status=>"open", :color=>"#077f40", :closed_by=>nil, :closed_at=>nil, :created_by=>0, :created_at=>1430208000, :updated_by=>0, :updated_at=>1430208000}], :files=>[{:name=>"障害報告書", :path=>"https://demo.reactio.jp/data/reactio-mvp/files/incident/1/_bYMRLTxj75lcXCWN0iaAZud2CuGqFFL/Screen_Shot.png"}], :users=>[{:id=>1}, {:id=>2}]}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/reactio/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/reactio.rb

@@ -0,0 +1,29 @@
+require 'reactio/version'
+require 'reactio/errors'
+require 'reactio/utils'
+require 'reactio/service'
+
+module Reactio
+
+  def self.included(base)
+    base.class_eval do
+      include InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+
+    def reactio
+      @reactio ||= create_service
+    end
+
+    private
+
+      def create_service
+        Service.new(
+          api_key: ENV['REACTIO_API_KEY'],
+          organization: ENV['REACTIO_ORGANIZATION']
+        )
+      end
+  end
+end

data/lib/reactio/api_client.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+require 'reactio/api_endpoint'
+require 'reactio/faraday_engine'
+
+module Reactio
+  class APIClient
+
+    class << self
+
+      def build(api_key, organization)
+        raise ArgumentError, 'api_key is required' unless api_key
+        raise ArgumentError, 'organization is required' unless organization
+        http_client = build_http_client(
+          api_key,
+          APIEndpoint.new(organization)
+        )
+        new(http_client)
+      end
+
+      def build_http_client(api_key, api_endpoint)
+        Faraday.new(url: api_endpoint.base_url) do |faraday|
+          faraday.use :reactio, api_key
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+
+    def initialize(http_client)
+      @http = http_client
+    end
+
+    def request(method, path, env = {})
+      response = @http.send(method, path, env[:body])
+      handle_api_response(response)
+    end
+
+    private
+
+      def handle_api_response(res)
+        case res.status
+        when 200..299
+          res.body
+        when 401
+          raise Reactio::AuthenticationError, res.body.inspect
+        when 400..499
+          raise Reactio::BadRequest, res.body.inspect
+        when 500..599
+          raise Reactio::ServerError, res.body.inspect
+        end
+      end
+  end
+end

data/lib/reactio/api_endpoint.rb

@@ -0,0 +1,23 @@
+require 'uri'
+
+module Reactio
+  class APIEndpoint
+    DOMAIN = 'reactio.jp'.freeze
+
+    attr_reader :organization
+
+    def initialize(organization)
+      @organization = organization
+      @base_url = URI::HTTPS.build(host: "#{organization}.#{DOMAIN}")
+    end
+
+    def base_url
+      @base_url.to_s
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) &&
+        self.organization == other.organization
+    end
+  end
+end

data/lib/reactio/errors.rb

@@ -0,0 +1,5 @@
+module Reactio
+  class BadRequest < StandardError; end
+  class AuthenticationError < StandardError; end
+  class ServerError < StandardError; end
+end

data/lib/reactio/faraday_engine.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'json'
+
+module Reactio
+  class FaradayEngine < Faraday::Middleware
+    USER_AGENT = "Reactio ruby v#{VERSION}".freeze
+    MIME_TYPE = 'application/json'.freeze
+
+    def initialize(app, api_key)
+      super(app)
+      @api_key = api_key
+    end
+
+    def call(request_env)
+      set_request_header(request_env)
+      encode_body(request_env)
+      @app.call(request_env).on_complete do |response_env|
+        decode_body(response_env)
+      end
+    end
+
+    private
+
+      def set_request_header(env)
+        env[:request_headers].merge!(
+          'Accept'        => MIME_TYPE,
+          'Content-Type'  => MIME_TYPE,
+          'X-Api-Key'     => @api_key,
+          'User-Agent'    => USER_AGENT
+        )
+      end
+
+      def encode_body(env)
+        env[:body] = JSON.dump(env[:body])
+      end
+
+      def decode_body(env)
+        env[:body] = JSON.parse(env[:body], symbolize_names: true)
+      end
+  end
+end
+
+Faraday::Middleware.register_middleware reactio: Reactio::FaradayEngine

data/lib/reactio/service.rb

@@ -0,0 +1,46 @@
+require 'reactio/api_client'
+
+module Reactio
+  class Service
+    include Utils
+
+    def initialize(options)
+      @api = APIClient.build(
+        options[:api_key],
+        options[:organization]
+      )
+    end
+
+    def create_incident(name, options = {})
+      payload = { name: name }.tap do |me|
+        me[:detection] = to_option_string(options.delete(:detection)) if options.key?(:detection)
+        me[:cause] = to_option_string(options.delete(:cause)) if options.key?(:cause)
+        me[:point] = to_option_string(options.delete(:point)) if options.key?(:point)
+        me[:scale] = to_option_string(options.delete(:scale)) if options.key?(:scale)
+      end
+        .merge!(options)
+      @api.request(:post, "/api/v1/incidents", body: payload)
+    end
+
+    def describe_incident(incident_id)
+      @api.request(:get, "/api/v1/incidents/#{incident_id}")
+    end
+
+    def list_incidents(options = {})
+      payload = {}.tap do |me|
+        me[:from] = options.delete(:from).to_i if options[:from]
+        me[:to] = options.delete(:to).to_i if options[:to]
+        me[:status] = options.delete(:status).to_s if options[:status]
+      end
+        .merge!(options)
+      @api.request(:get, "/api/v1/incidents", body: payload)
+    end
+
+    def notify_incident(incident_id, options = {})
+      @api.request(
+        :post, "/api/v1/notifications",
+        body: { incident_id: incident_id }.merge(options)
+      )
+    end
+  end
+end

data/lib/reactio/utils.rb

@@ -0,0 +1,10 @@
+module Reactio
+  module Utils
+    NIL_STRING = 'null'.freeze
+
+    def to_option_string(symbol)
+      return NIL_STRING if symbol.nil?
+      symbol.to_s.gsub('_', '-')
+    end
+  end
+end

data/lib/reactio/version.rb

@@ -0,0 +1,3 @@
+module Reactio
+  VERSION = "1.0.0"
+end

data/reactio.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reactio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reactio"
+  spec.version       = Reactio::VERSION
+  spec.authors       = ["Hajime Sueyoshi"]
+  spec.email         = ["hajime.sueyoshi@gaiax.com"]
+  spec.summary       = %q{Reactio API Client}
+  spec.description   = %q{The official Reactio API Client for ruby.}
+  spec.homepage      = "https://reactio.jp/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/fixtures/created_incident.yml

@@ -0,0 +1,59 @@
+---
+:id: 1
+:name: "サイト閲覧不可"
+:manager: 
+:status: open
+:detection: msp
+:cause: over-capacity
+:cause_supplement: Webサーバがアクセス過多でダウン
+:point: middleware
+:scale: whole
+:pend_text: Webサーバの再起動を行う
+:close_text: Webサーバのスケールアウトを行う
+:closed_by: 
+:closed_at: 
+:pended_by: 
+:pended_at: 
+:created_by: 0
+:created_at: 1430208000
+:updated_by: 0
+:updated_at: 1430208000
+:topics:
+- :id: 1
+  :name: "原因調査"
+  :status: open
+  :color: "#5661aa"
+  :closed_by: 
+  :closed_at: 
+  :created_by: 0
+  :created_at: 1430208000
+  :updated_by: 0
+  :updated_at: 1430208000
+- :id: 2
+  :name: "復旧作業"
+  :status: open
+  :color: "#077f40"
+  :closed_by: 
+  :closed_at: 
+  :created_by: 0
+  :created_at: 1430208000
+  :updated_by: 0
+  :updated_at: 1430208000
+:notifications:
+  :id: 1
+  :notification_text: "お疲れ様です。Webサーバで障害が発生しました。至急対応をお願い致します。"
+  :notification_call: true
+  :notificated_for:
+    :phone:
+    - '1'
+    - '3'
+    :email1:
+    - '1'
+    - '2'
+    - '3'
+    :email2:
+    - '1'
+    - '2'
+    :imkayac:
+    - '1'
+  :created_at: 1430208000