flapjack-diner 2.0.0.pre.alpha.1 → 2.0.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ca71cf066fca99781cc543fb931e950771c52bc
-  data.tar.gz: 3487411a016d2d23688a188f74462dce813aa29d
+  metadata.gz: ac8e83fdc9d402c3e60acfeb01b64a0d8f352ad6
+  data.tar.gz: ce8eecce83ca64e01dca304c8a453eb019c5c313
 SHA512:
-  metadata.gz: 6d48ca39d5c3bc2eeee576baf6f469a7afde1bfc68e67356ce076caeba28c0ef9a613157a49006c12305e5746d0a87328fa3e86340cb47eeb495241f15ea3348
-  data.tar.gz: f54b0e2abd6e8836c8d46c9328a9af2e23aa8fb19f4169787370b0a9b29102cc3704b308a470dfd9f88aef9bb0af534a97e351b402b1de6ddabbf89072a26bb5
+  metadata.gz: d5b3c08505bea0ed12897b2b437cc418f6194f09d4d6041a8155b86be638b5f8ce86538d1be8d30deb969c46c45db07f1ae959dc59ce8a6255c7ae292f308251
+  data.tar.gz: e741106cde2ec5631730f27708f0d775c806250c6850f3c05d6559e218ec2e635b888923265caab155cc97ea424448778bb000ead02340ef5f7e9db99868bdaf

data/lib/flapjack-diner.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'flapjack-diner/version'
 require 'flapjack-diner/argument_validator'
 
-%w(checks contacts events maintenance_periods media metrics rules
+%w(blackholes checks contacts events maintenance_periods media metrics rules
    states statistics tags relationships).each do |resource|
   require "flapjack-diner/resources/#{resource}"
 end
@@ -26,6 +26,7 @@ module Flapjack
     class << self
       attr_accessor :logger, :return_keys_as_strings
 
+      include Flapjack::Diner::Resources::Blackholes
       include Flapjack::Diner::Resources::Checks
       include Flapjack::Diner::Resources::Contacts
       include Flapjack::Diner::Resources::Events

data/lib/flapjack-diner/resources/blackholes.rb

@@ -0,0 +1,73 @@
+require 'httparty'
+require 'json'
+require 'uri'
+
+require 'flapjack-diner/version'
+require 'flapjack-diner/argument_validator'
+
+module Flapjack
+  module Diner
+    module Resources
+      module Blackholes
+
+        def create_blackholes(*args)
+          data = unwrap_data(*args)
+          validate_params(data) do
+            validate :query => :id, :as => :uuid
+            # TODO proper validation of time_restrictions field
+            validate :query => :conditions_list, :as => :string
+            validate :query => :contact, :as => [:singular_link_uuid, :required]
+            validate :query => :media, :as => :multiple_link_uuid
+            validate :query => :tags, :as => :multiple_link
+          end
+          _blackholes_validate_association(data)
+          perform_post(:blackholes, '/blackholes', data)
+        end
+
+        def blackholes(*args)
+          ids, data = unwrap_uuids(*args), unwrap_data(*args)
+          validate_params(data) do
+            validate :query => [:fields, :sort, :include], :as => :string_or_array_of_strings
+            validate :query => :filter,  :as => :hash
+            validate :query => [:page, :per_page], :as => :positive_integer
+          end
+          perform_get('/blackholes', ids, data)
+        end
+
+        def update_blackholes(*args)
+          data = unwrap_data(*args)
+          validate_params(data) do
+            validate :query => :id, :as => [:uuid, :required]
+            # TODO proper validation of time_restrictions field
+            validate :query => :conditions_list, :as => :string
+            validate :query => :media, :as => :multiple_link_uuid
+            validate :query => :tags, :as => :multiple_link
+          end
+          perform_patch(:blackholes, "/blackholes", data)
+        end
+
+        def delete_blackholes(*ids)
+          raise "'delete_blackholes' requires at least one blackhole id parameter" if ids.nil? || ids.empty?
+          perform_delete(:blackholes, '/blackholes', *ids)
+        end
+
+        private
+
+        def _blackholes_validate_association(data)
+          case data
+          when Array
+            data.each do |d|
+              unless d.has_key?(:contact)
+                raise ArgumentError.new("Contact association must be provided for all blackholes")
+              end
+            end
+          when Hash
+            unless data.has_key?(:contact)
+              raise ArgumentError.new("Contact association must be provided for blackhole")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flapjack-diner/resources/relationships.rb

@@ -12,6 +12,7 @@ module Flapjack
 
         TYPES = {
                   :acknowledgements => 'acknowledgement',
+                  :blackholes => 'blackhole',
                   :checks => 'check',
                   :contacts => 'contact',
                   :media => 'medium',
@@ -37,6 +38,20 @@ module Flapjack
               :number => :singular, :link => false, :includable => false
             }
           },
+          :blackholes => {
+            :contact => {
+              :post => true, :get => true,
+              :number => :singular, :link => true, :includable => true
+            },
+            :media => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true
+            },
+            :tags => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true
+            }
+          },
           :checks => {
             :alerting_media => {
               :get => true,
@@ -80,6 +95,10 @@ module Flapjack
             }
           },
           :contacts => {
+            :blackholes => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true
+            },
             :checks => {
               :get => true,
               :number => :multiple, :link => true, :includable => true
@@ -98,6 +117,10 @@ module Flapjack
               :get => true,
               :number => :multiple, :link => true, :includable => true
             },
+            :blackholes => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true
+            },
             :contact => {
               :post => true, :get => true,
               :number => :singular, :link => true, :includable => true
@@ -138,6 +161,10 @@ module Flapjack
             }
           },
           :tags => {
+            :blackholes => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true
+            },
             :checks => {
               :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true

data/lib/flapjack-diner/resources/rules.rb

@@ -16,7 +16,6 @@ module Flapjack
             validate :query => :id, :as => :uuid
             # TODO proper validation of time_restrictions field
             validate :query => :conditions_list, :as => :string
-            validate :query => :is_blackhole, :as => :boolean
             validate :query => :contact, :as => [:singular_link_uuid, :required]
             validate :query => :media, :as => :multiple_link_uuid
             validate :query => :tags, :as => :multiple_link
@@ -41,7 +40,6 @@ module Flapjack
             validate :query => :id, :as => [:uuid, :required]
             # TODO proper validation of time_restrictions field
             validate :query => :conditions_list, :as => :string
-            validate :query => :is_blackhole, :as => :boolean
             validate :query => :media, :as => :multiple_link_uuid
             validate :query => :tags, :as => :multiple_link
           end

data/lib/flapjack-diner/version.rb

@@ -1,5 +1,5 @@
 module Flapjack
   module Diner
-    VERSION = '2.0.0-alpha.1'
+    VERSION = '2.0.0-alpha.2'
   end
 end

data/spec/resources/blackholes_spec.rb

@@ -0,0 +1,278 @@
+require 'spec_helper'
+require 'flapjack-diner'
+
+describe Flapjack::Diner::Resources::Blackholes, :pact => true do
+
+  before(:each) do
+    Flapjack::Diner.base_uri('localhost:19081')
+    Flapjack::Diner.logger = nil
+  end
+
+  context 'create' do
+
+    it "submits a POST request for a blackhole" do
+      req_data  = blackhole_json(blackhole_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      )
+      resp_data = blackhole_json(blackhole_data).merge(:relationships => blackhole_rel(blackhole_data))
+
+      flapjack.given("a contact exists").
+        upon_receiving("a POST request with one blackhole").
+        with(:method => :post, :path => '/blackholes',
+             :headers => {'Content-Type' => 'application/vnd.api+json'},
+             :body => {:data => req_data}).
+        will_respond_with(
+          :status => 201,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+         :body => {:data => resp_data}
+        )
+
+      result = Flapjack::Diner.create_blackholes(blackhole_data.merge(:contact => contact_data[:id]))
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "submits a POST request for several blackholes" do
+      req_data = [blackhole_json(blackhole_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      ), blackhole_json(blackhole_2_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      )]
+      resp_data = [
+        blackhole_json(blackhole_data).merge(:relationships => blackhole_rel(blackhole_data)),
+        blackhole_json(blackhole_2_data).merge(:relationships => blackhole_rel(blackhole_2_data))
+      ]
+
+      flapjack.given("a contact exists").
+        upon_receiving("a POST request with two blackholes").
+        with(:method => :post, :path => '/blackholes',
+             :headers => {'Content-Type' => 'application/vnd.api+json; ext=bulk'},
+             :body => {:data => req_data}).
+        will_respond_with(
+          :status => 201,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+          :body => {:data => resp_data}
+        )
+
+      result = Flapjack::Diner.create_blackholes(blackhole_data.merge(:contact => contact_data[:id]),
+                                            blackhole_2_data.merge(:contact => contact_data[:id]))
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    # TODO error due to invalid data
+
+  end
+
+  context 'read' do
+
+    it "submits a GET request for all blackholes" do
+      resp_data = [blackhole_json(blackhole_data).merge(:relationships => blackhole_rel(blackhole_data))]
+
+      flapjack.given("a blackhole exists").
+        upon_receiving("a GET request for all blackholes").
+        with(:method => :get, :path => '/blackholes').
+        will_respond_with(
+          :status => 200,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+            :body => {:data => resp_data} )
+
+      result = Flapjack::Diner.blackholes
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "submits a GET request for one blackhole" do
+      resp_data = blackhole_json(blackhole_data).merge(:relationships => blackhole_rel(blackhole_data))
+
+      flapjack.given("a blackhole exists").
+        upon_receiving("a GET request for a single blackhole").
+        with(:method => :get, :path => "/blackholes/#{blackhole_data[:id]}").
+        will_respond_with(
+          :status => 200,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+            :body => {:data => resp_data}
+        )
+
+      result = Flapjack::Diner.blackholes(blackhole_data[:id])
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "submits a GET request for several blackholes" do
+      resp_data = [
+        blackhole_json(blackhole_data).merge(:relationships => blackhole_rel(blackhole_data)),
+        blackhole_json(blackhole_2_data).merge(:relationships => blackhole_rel(blackhole_2_data))
+      ]
+
+      blackholes_data = [blackhole_data.merge(:type => 'blackhole'), blackhole_2_data.merge(:type => 'blackhole')]
+
+      flapjack.given("two blackholes exist").
+        upon_receiving("a GET request for two blackholes").
+        with(:method => :get, :path => "/blackholes",
+             :query => "filter%5B%5D=id%3A#{blackhole_data[:id]}%7C#{blackhole_2_data[:id]}").
+        will_respond_with(
+          :status => 200,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+            :body => {:data => resp_data} )
+
+      result = Flapjack::Diner.blackholes(blackhole_data[:id], blackhole_2_data[:id])
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "can't find the blackhole to read" do
+      flapjack.given("no data exists").
+        upon_receiving("a GET request for a single blackhole").
+        with(:method => :get, :path => "/blackholes/#{blackhole_data[:id]}").
+        will_respond_with(
+          :status => 404,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+          :body => {:errors => [{
+              :status => '404',
+              :detail => "could not find Blackhole record, id: '#{blackhole_data[:id]}'"
+            }]}
+          )
+
+      result = Flapjack::Diner.blackholes(blackhole_data[:id])
+      expect(result).to be_nil
+      expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+        :detail => "could not find Blackhole record, id: '#{blackhole_data[:id]}'"}])
+    end
+
+  end
+
+  # # Not immediately relevant, no data fields to update until time_restrictions are fixed
+  # context 'update' do
+  #   it 'submits a PUT request for a blackhole' do
+  #     flapjack.given("a blackhole exists").
+  #       upon_receiving("a PUT request for a single blackhole").
+  #       with(:method => :put,
+  #            :path => "/blackholes/#{blackhole_data[:id]}",
+  #            :body => {:blackholes => {:id => blackhole_data[:id], :time_restrictions => []}},
+  #            :headers => {'Content-Type' => 'application/vnd.api+json'}).
+  #       will_respond_with(
+  #         :status => 204,
+  #         :body => '' )
+
+  #     result = Flapjack::Diner.update_blackholes(:id => blackhole_data[:id], :time_restrictions => [])
+  #     expect(result).to be_a(TrueClass)
+  #   end
+
+  #   it 'submits a PUT request for several blackholes' do
+  #     flapjack.given("two blackholes exist").
+  #       upon_receiving("a PUT request for two blackholes").
+  #       with(:method => :put,
+  #            :path => "/blackholes/#{blackhole_data[:id]},#{blackhole_2_data[:id]}",
+  #            :body => {:blackholes => [{:id => blackhole_data[:id], :time_restrictions => []},
+  #            {:id => blackhole_2_data[:id], :enabled => true}]},
+  #            :headers => {'Content-Type' => 'application/vnd.api+json'}).
+  #       will_respond_with(
+  #         :status => 204,
+  #         :body => '' )
+
+  #     result = Flapjack::Diner.update_blackholes(
+  #       {:id => blackhole_data[:id], :time_restrictions => []},
+  #       {:id => blackhole_2_data[:id], :enabled => true})
+  #     expect(result).to be_a(TrueClass)
+  #   end
+
+  #   it "can't find the blackhole to update" do
+  #     flapjack.given("no data exists").
+  #       upon_receiving("a PUT request for a single blackhole").
+  #       with(:method => :put,
+  #            :path => "/blackholes/#{blackhole_data[:id]}",
+  #            :body => {:blackholes => {:id => blackhole_data[:id], :time_restrictions => []}},
+  #            :headers => {'Content-Type' => 'application/vnd.api+json'}).
+  #       will_respond_with(
+  #         :status => 404,
+  #         :headers => {'Content-Type' => 'application/vnd.api+json; charset=utf-8'},
+  #         :body => {:errors => [{
+  #             :status => '404',
+  #             :detail => "could not find Blackhole records, ids: '#{blackhole_data[:id]}'"
+  #           }]}
+  #         )
+
+  #     result = Flapjack::Diner.update_blackholes(:id => blackhole_data[:id], :time_restrictions => [])
+  #     expect(result).to be_nil
+  #     expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+  #       :detail => "could not find Blackhole records, ids: '#{blackhole_data[:id]}'"}])
+  #   end
+  # end
+
+  context 'delete' do
+
+    it "submits a DELETE request for a blackhole" do
+      flapjack.given("a blackhole exists").
+        upon_receiving("a DELETE request for a single blackhole").
+        with(:method => :delete,
+             :path => "/blackholes/#{blackhole_data[:id]}",
+             :body => nil).
+        will_respond_with(:status => 204,
+                          :body => '')
+
+      result = Flapjack::Diner.delete_blackholes(blackhole_data[:id])
+      expect(result).to be_a(TrueClass)
+    end
+
+    it "submits a DELETE request for several blackholes" do
+      blackholes_data = [{:type => 'blackhole', :id => blackhole_data[:id]},
+                    {:type => 'blackhole', :id => blackhole_2_data[:id]}]
+
+      flapjack.given("two blackholes exist").
+        upon_receiving("a DELETE request for two blackholes").
+        with(:method => :delete,
+             :headers => {'Content-Type' => 'application/vnd.api+json; ext=bulk'},
+             :path => "/blackholes",
+             :body => {:data => blackholes_data}).
+        will_respond_with(:status => 204,
+                          :body => '')
+
+      result = Flapjack::Diner.delete_blackholes(blackhole_data[:id], blackhole_2_data[:id])
+      expect(result).to be_a(TrueClass)
+    end
+
+    it "can't find the blackhole to delete" do
+      flapjack.given("no data exists").
+        upon_receiving("a DELETE request for a single blackhole").
+        with(:method => :delete,
+             :path => "/blackholes/#{blackhole_data[:id]}",
+             :body => nil).
+        will_respond_with(
+          :status => 404,
+          :headers => {'Content-Type' => 'application/vnd.api+json; supported-ext=bulk; charset=utf-8'},
+          :body => {:errors => [{
+              :status => '404',
+              :detail => "could not find Blackhole record, id: '#{blackhole_data[:id]}'"
+            }]}
+          )
+
+      result = Flapjack::Diner.delete_blackholes(blackhole_data[:id])
+      expect(result).to be_nil
+      expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+        :detail => "could not find Blackhole record, id: '#{blackhole_data[:id]}'"}])
+    end
+  end
+
+end

data/spec/support/fixture_data.rb

@@ -162,6 +162,12 @@ module FixtureData
   def contact_rel(co_data)
     id = co_data[:id]
     {
+      :blackholes => {
+        :links => {
+          :self => "http://#{api_host}/contacts/#{id}/relationships/blackholes",
+          :related => "http://#{api_host}/contacts/#{id}/blackholes"
+        }
+      },
       :checks => {
         :links => {
           :self => "http://#{api_host}/contacts/#{id}/relationships/checks",
@@ -301,7 +307,6 @@ module FixtureData
   def rule_data
     @rule_data ||= {
       :id          => '05983623-fcef-42da-af44-ed6990b500fa',
-      :is_blackhole => false,
       :conditions_list => 'critical'
     }
   end
@@ -309,7 +314,6 @@ module FixtureData
   def rule_2_data
     @rule_2_data ||= {
       :id          => '20f182fc-6e32-4794-9007-97366d162c51',
-      :is_blackhole => false,
       :conditions_list => 'warning'
     }
   end
@@ -346,12 +350,58 @@ module FixtureData
     }
   end
 
+  def blackhole_data
+    @blackhole_data ||= {
+      :id          => '05983623-fcef-42da-af44-ed6990b500fa',
+      :conditions_list => 'critical'
+    }
+  end
+
+  def blackhole_2_data
+    @blackhole_2_data ||= {
+      :id          => '20f182fc-6e32-4794-9007-97366d162c51',
+      :conditions_list => 'warning'
+    }
+  end
+
+  def blackhole_json(bl_data)
+    {
+      :id => bl_data[:id],
+      :type => 'blackhole',
+      :attributes => bl_data.reject {|k,v| :id.eql?(k) }
+    }
+  end
+
+  def blackhole_rel(bl_data)
+    id = bl_data[:id]
+    {
+      :contact => {
+        :links => {
+          :self => "http://example.org/blackholes/#{id}/relationships/contact",
+          :related => "http://example.org/blackholes/#{id}/contact"
+        }
+      },
+      :media => {
+        :links => {
+          :self => "http://example.org/blackholes/#{id}/relationships/media",
+          :related => "http://example.org/blackholes/#{id}/media"
+        }
+      },
+      :tags => {
+        :links => {
+          :self => "http://example.org/blackholes/#{id}/relationships/tags",
+          :related => "http://example.org/blackholes/#{id}/tags"
+        }
+      }
+    }
+  end
+
   def state_data
     @state_data ||= {
       :id => '142acf62-31e7-4074-ada9-a30ae73d880d',
       :created_at => (fixture_time - 30).iso8601,
       :updated_at => (fixture_time - 30).iso8601,
-      :condition => 'critical'
+      :condition => 'critical',
     }
   end
 
@@ -360,7 +410,7 @@ module FixtureData
       :id => '008d78fc-1c72-4c2a-8057-0d44b64c6f3d',
       :created_at => (fixture_time - 10).iso8601,
       :updated_at => (fixture_time - 10).iso8601,
-      :condition => 'ok'
+      :condition => 'ok',
     }
   end
 
@@ -408,6 +458,12 @@ module FixtureData
   def tag_rel(ta_data)
     id = ta_data[:name]
     {
+      :blackholes => {
+        :links => {
+          :self => "http://#{api_host}/tags/#{id}/relationships/blackholes",
+          :related => "http://#{api_host}/tags/#{id}/blackholes"
+        }
+      },
       :checks => {
         :links => {
           :self => "http://#{api_host}/tags/#{id}/relationships/checks",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flapjack-diner
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  version: 2.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Ali Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -58,6 +58,7 @@ files:
 - lib/flapjack-diner.rb
 - lib/flapjack-diner/argument_validator.rb
 - lib/flapjack-diner/index_range.rb
+- lib/flapjack-diner/resources/blackholes.rb
 - lib/flapjack-diner/resources/checks.rb
 - lib/flapjack-diner/resources/contacts.rb
 - lib/flapjack-diner/resources/events.rb
@@ -74,6 +75,7 @@ files:
 - log/.gitkeep
 - spec/argument_validator_spec.rb
 - spec/flapjack-diner_spec.rb
+- spec/resources/blackholes_spec.rb
 - spec/resources/checks_spec.rb
 - spec/resources/contacts_spec.rb
 - spec/resources/events_spec.rb
@@ -113,6 +115,7 @@ summary: Access the API of a Flapjack system monitoring server
 test_files:
 - spec/argument_validator_spec.rb
 - spec/flapjack-diner_spec.rb
+- spec/resources/blackholes_spec.rb
 - spec/resources/checks_spec.rb
 - spec/resources/contacts_spec.rb
 - spec/resources/events_spec.rb