reactio 1.0.0

data/spec/fixtures/incident.yml

@@ -0,0 +1,47 @@
+---
+:id: 123
+: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
+:files:
+- :name: "障害報告書"
+  :path: https://gaiax-dev.reactio.jp/data/reactio-mvp/files/incident/1/_bYMRLTxj75lcXCWN0iaAZud2CuGqFFL/Screen_Shot.png
+:users:
+- :id: 1
+- :id: 2

data/spec/fixtures/incident_list.yml

@@ -0,0 +1,39 @@
+---
+- :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
+- :id: 2
+  :name: "サイト閲覧不可2"
+  :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: 1430209000
+  :updated_by: 0
+  :updated_at: 1430209000

data/spec/fixtures/notification.yml

@@ -0,0 +1,18 @@
+---
+:id: 33
+:notification_text: "お疲れ様です。Webサーバで障害が発生しました。至急対応をお願い致します。"
+:notification_call: true
+:notificated_for:
+  :phone:
+  - '1'
+  - '3'
+  :email1:
+  - '1'
+  - '2'
+  - '3'
+  :email2:
+  - '1'
+  - '2'
+  :imkayac:
+  - '1'
+:created_at: 1430208000

data/spec/reactio_spec.rb

@@ -0,0 +1,19 @@
+describe 'use Reactio as module' do
+  before do
+    ENV['REACTIO_API_KEY'] = 'THE_API_KEY'
+    ENV['REACTIO_ORGANIZATION'] = 'my-organization'
+  end
+
+  let(:included_class) do
+    Class.new.instance_eval { include Reactio }
+  end
+
+  let(:obj) do
+    included_class.new
+  end
+
+  it { expect(obj.reactio).to respond_to(:create_incident) }
+  it { expect(obj.reactio).to respond_to(:describe_incident) }
+  it { expect(obj.reactio).to respond_to(:list_incidents) }
+  it { expect(obj.reactio).to respond_to(:notify_incident) }
+end

data/spec/service_spec.rb

@@ -0,0 +1,40 @@
+module Reactio
+  describe Service do
+    describe '.new' do
+      let(:api_key) { 'THE_API_KEY' }
+      let(:organization) { 'my-organization' }
+
+      context 'given valid options' do
+        subject do
+          described_class
+            .new(
+              api_key: api_key,
+              organization: organization
+            )
+        end
+        it { expect { subject }.to_not raise_error }
+      end
+
+      context 'given only api_key option' do
+        subject do
+          described_class.new(api_key: api_key)
+        end
+        it { expect { subject }.to raise_error(ArgumentError, 'organization is required') }
+      end
+
+      context 'given only organization option' do
+        subject do
+          described_class.new(organization: organization)
+        end
+        it { expect { subject }.to raise_error(ArgumentError, 'api_key is required') }
+      end
+
+      context 'given no options' do
+        subject do
+          described_class.new
+        end
+        it { expect { subject }.to raise_error(ArgumentError) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require 'reactio'
+require 'webmock/rspec'
+
+Dir[File.expand_path('../support', __FILE__) + '/**/*.rb' ].each {|f| require f }
+
+FIXTURES_ROOT = File.expand_path('../fixtures', __FILE__)
+
+def fixture(name)
+  YAML.load_file("#{FIXTURES_ROOT}/#{name}.yml")
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include RequestStubHelper
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/default_client_context.rb

@@ -0,0 +1,5 @@
+shared_context 'default_service_context' do
+  let(:service) { Reactio::Service.new(api_key: api_key, organization: organization) }
+  let(:api_key) { 'api_key_for_organization' }
+  let(:organization) { 'your-organization' }
+end

data/spec/support/request_stub_helper.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module RequestStubHelper
+  MIME_TYPE = 'application/json'.freeze
+
+  def stub_api_request(organization, api_key, spec)
+    params = {}
+    params[:headers] = build_headers(api_key)
+    params[:body] = spec[:body] if spec.key?(:body)
+    params[:query] = spec[:query] if spec.key?(:query)
+
+    stub_request(
+      spec[:method],
+      "https://#{organization}.reactio.jp#{spec[:path]}"
+    ).with(params)
+  end
+
+  def build_headers(api_key)
+    {
+      'Accept' => MIME_TYPE,
+      'Content-Type' => MIME_TYPE,
+      'X-Api-Key' => api_key
+    }
+  end
+end

data/spec/v1/create_incident_spec.rb

@@ -0,0 +1,254 @@
+describe 'create incident' do
+  include_context 'default_service_context'
+
+  subject do
+    service.create_incident(name, options)
+  end
+
+  let(:name) { 'サイト閲覧不可' }
+
+  before { stub }
+
+  let(:stub) do
+    stub_api_request(
+      organization, api_key,
+      method: :post, path: '/api/v1/incidents',
+      body: { name: name }.merge(expected_options).to_json
+    ).to_return(
+      status: 201,
+      body: incident.to_json
+    )
+  end
+
+  let(:incident) { fixture('created_incident') }
+
+  context 'without options' do
+    subject { service.create_incident(name) }
+    let(:expected_options) { {} }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with status option' do
+    let(:options) { { status: status } }
+    let(:expected_options) { { status: status } }
+
+    context 'given :open as status' do
+      let(:status) { 'open' }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given :pend as status' do
+      let(:status) { 'pend' }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given :close as status' do
+      let(:status) { 'close' }
+      it { is_expected.to eq(incident) }
+    end
+  end
+
+  context 'with detection option' do
+    let(:options) { { detection: detection } }
+
+    context 'given :msp as detection' do
+      let(:detection) { 'msp' }
+      let(:expected_options) { { detection: 'msp' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given :system as detection' do
+      let(:detection) { 'system' }
+      let(:expected_options) { { detection: 'system' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given :client as detection' do
+      let(:detection) { 'client' }
+      let(:expected_options) { { detection: 'client' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given :internal as detection' do
+      let(:detection) { 'internal' }
+      let(:expected_options) { { detection: 'internal' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given nil as detection' do
+      let(:detection) { nil }
+      let(:expected_options) { { detection: 'null' } }
+      it { is_expected.to eq(incident) }
+    end
+  end
+
+  context 'with cause option' do
+    let(:options) { { cause: cause } }
+
+    context 'given over-capacity as cause' do
+      let(:cause) { 'over-capacity' }
+      let(:expected_options) { { cause: 'over-capacity' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given bug as cause' do
+      let(:cause) { 'bug' }
+      let(:expected_options) { { cause: 'bug' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given operation-error as cause' do
+      let(:cause) { 'operation-error' }
+      let(:expected_options) { { cause: 'operation-error' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given external-factor as cause' do
+      let(:cause) { 'external-factor' }
+      let(:expected_options) { { cause: 'external-factor' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given degradation as cause' do
+      let(:cause) { 'degradation' }
+      let(:expected_options) { { cause: 'degradation' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given unknown as cause' do
+      let(:cause) { 'unknown' }
+      let(:expected_options) { { cause: 'unknown' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given nil as cause' do
+      let(:cause) { nil }
+      let(:expected_options) { { cause: 'null' } }
+      it { is_expected.to eq(incident) }
+    end
+  end
+
+  context 'with cause_supplement option' do
+    let(:options) { { cause_supplement: cause_supplement } }
+    let(:expected_options) { { cause_supplement: cause_supplement } }
+    let(:cause_supplement) { 'Webサーバがアクセス過多でダウン' }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with point option' do
+    let(:options) { { point: point } }
+
+    context 'given network as point' do
+      let(:point) { 'network' }
+      let(:expected_options) { { point: 'network' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given shared-hardware as point' do
+      let(:point) { 'shared-hardware' }
+      let(:expected_options) { { point: 'shared-hardware' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given hardware as point' do
+      let(:point) { 'hardware' }
+      let(:expected_options) { { point: 'hardware' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given os as point' do
+      let(:point) { 'os' }
+      let(:expected_options) { { point: 'os' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given middleware as point' do
+      let(:point) { 'middleware' }
+      let(:expected_options) { { point: 'middleware' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given application as point' do
+      let(:point) { 'application' }
+      let(:expected_options) { { point: 'application' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given nil as point' do
+      let(:point) { nil }
+      let(:expected_options) { { point: 'null' } }
+      it { is_expected.to eq(incident) }
+    end
+  end
+
+  context 'with scale option' do
+    let(:options) { { scale: scale } }
+
+    context 'given cross as scale' do
+      let(:scale) { 'cross' }
+      let(:expected_options) { { scale: 'cross' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given whole as scale' do
+      let(:scale) { 'whole' }
+      let(:expected_options) { { scale: 'whole' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given point as scale' do
+      let(:scale) { 'point' }
+      let(:expected_options) { { scale: 'point' } }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given nil as scale' do
+      let(:scale) { nil }
+      let(:expected_options) { { scale: 'null' } }
+      it { is_expected.to eq(incident) }
+    end
+  end
+
+  context 'with pend_text option' do
+    let(:options) { { pend_text: pend_text } }
+    let(:expected_options) { { pend_text: pend_text } }
+    let(:pend_text) { 'Webサーバの再起動を行う' }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with close_text option' do
+    let(:options) { { close_text: close_text } }
+    let(:expected_options) { { close_text: close_text } }
+    let(:close_text) { 'Webサーバのスケールアウトを行う' }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with topics option' do
+    let(:options) { { topics: topics } }
+    let(:expected_options) { { topics: topics } }
+    let(:topics) { %w(原因調査 復旧作業) }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with notification_text option' do
+    let(:options) { { notification_text: notification_text } }
+    let(:expected_options) { { notification_text: notification_text } }
+    let(:notification_text) { '至急対応をお願いします。' }
+    it { is_expected.to eq(incident) }
+  end
+
+  context 'with notification_call option' do
+    let(:options) { { notification_call: notification_call } }
+    let(:expected_options) { { notification_call: notification_call } }
+
+    context 'given true as notification_call' do
+      let(:notification_call) { true }
+      it { is_expected.to eq(incident) }
+    end
+
+    context 'given false as notification_call' do
+      let(:notification_call) { false }
+      it { is_expected.to eq(incident) }
+    end
+  end
+end