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

data/lib/flapjack-diner/resources/{blackholes.rb → acceptors.rb}

@@ -8,62 +8,66 @@ require 'flapjack-diner/argument_validator'
 module Flapjack
   module Diner
     module Resources
-      module Blackholes
+      module Acceptors
 
-        def create_blackholes(*args)
+        def create_acceptors(*args)
           data = unwrap_data(*args)
           validate_params(data) do
             validate :query => :id, :as => :uuid
-            # TODO proper validation of time_restrictions field
+            validate :query => :name, :as => :string
+            validate :query => :all, :as => :boolean
             validate :query => :conditions_list, :as => :string
+            # TODO proper validation of time_restrictions field
             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)
+          _acceptors_validate_association(data)
+          perform_post(:acceptors, '/acceptors', data)
         end
 
-        def blackholes(*args)
+        def acceptors(*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)
+          perform_get('/acceptors', ids, data)
         end
 
-        def update_blackholes(*args)
+        def update_acceptors(*args)
           data = unwrap_data(*args)
           validate_params(data) do
             validate :query => :id, :as => [:uuid, :required]
-            # TODO proper validation of time_restrictions field
+            validate :query => :name, :as => :string
+            validate :query => :all, :as => :boolean
             validate :query => :conditions_list, :as => :string
+            # TODO proper validation of time_restrictions field
             validate :query => :media, :as => :multiple_link_uuid
             validate :query => :tags, :as => :multiple_link
           end
-          perform_patch(:blackholes, "/blackholes", data)
+          perform_patch(:acceptors, "/acceptors", 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)
+        def delete_acceptors(*ids)
+          raise "'delete_acceptors' requires at least one acceptor id parameter" if ids.nil? || ids.empty?
+          perform_delete(:acceptors, '/acceptors', *ids)
         end
 
         private
 
-        def _blackholes_validate_association(data)
+        def _acceptors_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")
+                raise ArgumentError.new("Contact association must be provided for all acceptors")
               end
             end
           when Hash
             unless data.has_key?(:contact)
-              raise ArgumentError.new("Contact association must be provided for blackhole")
+              raise ArgumentError.new("Contact association must be provided for acceptor")
             end
           end
         end

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

@@ -19,7 +19,7 @@ module Flapjack
             validate :query => [:interval, :rollup_threshold,
                                 :pagerduty_ack_duration], :as => :positive_integer
             validate :query => :contact, :as => [:singular_link_uuid, :required]
-            validate :query => :rules, :as => :multiple_link_uuid
+            validate :query => [:acceptors, :rejectors], :as => :multiple_link_uuid
           end
           perform_post(:media, "/media", data)
         end
@@ -42,7 +42,7 @@ module Flapjack
                                 :pagerduty_token], :as => :non_empty_string
             validate :query => [:interval, :rollup_threshold,
                                 :pagerduty_ack_duration], :as => :positive_integer
-            validate :query => :rules, :as => :multiple_link_uuid
+            validate :query => [:acceptors, :rejectors], :as => :multiple_link_uuid
           end
           perform_patch(:media, "/media", data)
         end

data/lib/flapjack-diner/resources/{rules.rb → rejectors.rb}

@@ -8,62 +8,66 @@ require 'flapjack-diner/argument_validator'
 module Flapjack
   module Diner
     module Resources
-      module Rules
+      module Rejectors
 
-        def create_rules(*args)
+        def create_rejectors(*args)
           data = unwrap_data(*args)
           validate_params(data) do
             validate :query => :id, :as => :uuid
-            # TODO proper validation of time_restrictions field
+            validate :query => :name, :as => :string
+            validate :query => :all, :as => :boolean
             validate :query => :conditions_list, :as => :string
+            # TODO proper validation of time_restrictions field
             validate :query => :contact, :as => [:singular_link_uuid, :required]
             validate :query => :media, :as => :multiple_link_uuid
             validate :query => :tags, :as => :multiple_link
           end
-          _rules_validate_association(data)
-          perform_post(:rules, '/rules', data)
+          _rejectors_validate_association(data)
+          perform_post(:rejectors, '/rejectors', data)
         end
 
-        def rules(*args)
+        def rejectors(*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('/rules', ids, data)
+          perform_get('/rejectors', ids, data)
         end
 
-        def update_rules(*args)
+        def update_rejectors(*args)
           data = unwrap_data(*args)
           validate_params(data) do
             validate :query => :id, :as => [:uuid, :required]
-            # TODO proper validation of time_restrictions field
+            validate :query => :name, :as => :string
+            validate :query => :all, :as => :boolean
             validate :query => :conditions_list, :as => :string
+            # TODO proper validation of time_restrictions field
             validate :query => :media, :as => :multiple_link_uuid
             validate :query => :tags, :as => :multiple_link
           end
-          perform_patch(:rules, "/rules", data)
+          perform_patch(:rejectors, "/rejectors", data)
         end
 
-        def delete_rules(*ids)
-          raise "'delete_rules' requires at least one rule id parameter" if ids.nil? || ids.empty?
-          perform_delete(:rules, '/rules', *ids)
+        def delete_rejectors(*ids)
+          raise "'delete_rejectors' requires at least one rejector id parameter" if ids.nil? || ids.empty?
+          perform_delete(:rejectors, '/rejectors', *ids)
         end
 
         private
 
-        def _rules_validate_association(data)
+        def _rejectors_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 rules")
+                raise ArgumentError.new("Contact association must be provided for all rejectors")
               end
             end
           when Hash
             unless data.has_key?(:contact)
-              raise ArgumentError.new("Contact association must be provided for rule")
+              raise ArgumentError.new("Contact association must be provided for rejector")
             end
           end
         end

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

@@ -11,12 +11,12 @@ module Flapjack
       module Relationships
 
         TYPES = {
+                  :acceptors => 'acceptor',
                   :acknowledgements => 'acknowledgement',
-                  :blackholes => 'blackhole',
                   :checks => 'check',
                   :contacts => 'contact',
                   :media => 'medium',
-                  :rules => 'rule',
+                  :rejectors => 'rejector',
                   :scheduled_maintenances   => 'scheduled_maintenance',
                   :states => 'state',
                   :tags => 'tag',
@@ -28,17 +28,7 @@ module Flapjack
 
         # extracted from flapjack data models' "jsonapi_associations" class method
         ASSOCIATIONS = {
-          :acknowledgements => {
-            :check => {
-              :post => true,
-              :number => :singular, :link => false, :includable => false
-            },
-            :tag => {
-              :post => true,
-              :number => :singular, :link => false, :includable => false
-            }
-          },
-          :blackholes => {
+          :acceptors => {
             :contact => {
               :post => true, :get => true,
               :number => :singular, :link => true, :includable => true
@@ -52,6 +42,16 @@ module Flapjack
               :number => :multiple, :link => true, :includable => true
             }
           },
+          :acknowledgements => {
+            :check => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false
+            },
+            :tag => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false
+            }
+          },
           :checks => {
             :alerting_media => {
               :get => true,
@@ -95,7 +95,7 @@ module Flapjack
             }
           },
           :contacts => {
-            :blackholes => {
+            :acceptors => {
               :get => true,
               :number => :multiple, :link => true, :includable => true
             },
@@ -107,30 +107,30 @@ module Flapjack
               :get => true,
               :number => :multiple, :link => true, :includable => true
             },
-            :rules => {
+            :rejectors => {
               :get => :true,
               :number => :multiple, :link => true, :includable => true
             }
           },
           :media => {
-            :alerting_checks => {
-              :get => true,
+            :acceptors => {
+              :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true
             },
-            :blackholes => {
-              :post => true, :get => true, :patch => true, :delete => true,
+            :alerting_checks => {
+              :get => true,
               :number => :multiple, :link => true, :includable => true
             },
             :contact => {
               :post => true, :get => true,
               :number => :singular, :link => true, :includable => true
             },
-            :rules => {
+            :rejectors => {
               :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true
             }
           },
-          :rules => {
+          :rejectors => {
             :contact => {
               :post => true, :get => true,
               :number => :singular, :link => true, :includable => true
@@ -161,7 +161,7 @@ module Flapjack
             }
           },
           :tags => {
-            :blackholes => {
+            :acceptors => {
               :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true
             },
@@ -169,9 +169,21 @@ module Flapjack
               :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true
             },
-            :rules => {
+            :rejectors => {
               :post => true, :get => true, :patch => true, :delete => true,
               :number => :multiple, :link => true, :includable => true
+            },
+            :scheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false
+            },
+            :states => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false
+            },
+            :unscheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false
             }
           },
           :test_notifications => {

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

@@ -13,7 +13,7 @@ module Flapjack
           data = unwrap_data(*args)
           validate_params(data) do
             validate :query => :name, :as => [:required, :non_empty_string]
-            validate :query => [:checks, :rules], :as => :multiple_link_uuid
+            validate :query => [:checks, :acceptors, :rejectors], :as => :multiple_link_uuid
           end
           perform_post(:tags, '/tags', data)
         end
@@ -31,7 +31,7 @@ module Flapjack
         def update_tags(*args)
           data = unwrap_data(*args)
           validate_params(data) do
-            validate :query => [:checks, :rules], :as => :multiple_link_uuid
+            validate :query => [:checks, :acceptors, :rejectors], :as => :multiple_link_uuid
           end
           perform_patch(:tags, "/tags", data)
         end

data/lib/flapjack-diner/version.rb

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

data/spec/resources/acceptors_spec.rb

@@ -0,0 +1,278 @@
+require 'spec_helper'
+require 'flapjack-diner'
+
+describe Flapjack::Diner::Resources::Acceptors, :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 an acceptor" do
+      req_data  = acceptor_json(acceptor_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      )
+      resp_data = acceptor_json(acceptor_data).merge(:relationships => acceptor_rel(acceptor_data))
+
+      flapjack.given("a contact exists").
+        upon_receiving("a POST request with one acceptor").
+        with(:method => :post, :path => '/acceptors',
+             :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_acceptors(acceptor_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 acceptors" do
+      req_data = [acceptor_json(acceptor_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      ), acceptor_json(acceptor_2_data).merge(
+        :relationships => {
+          :contact => {
+            :data => {
+              :type => 'contact',
+              :id => contact_data[:id]
+            }
+          }
+        }
+      )]
+      resp_data = [
+        acceptor_json(acceptor_data).merge(:relationships => acceptor_rel(acceptor_data)),
+        acceptor_json(acceptor_2_data).merge(:relationships => acceptor_rel(acceptor_2_data))
+      ]
+
+      flapjack.given("a contact exists").
+        upon_receiving("a POST request with two acceptors").
+        with(:method => :post, :path => '/acceptors',
+             :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_acceptors(acceptor_data.merge(:contact => contact_data[:id]),
+                                            acceptor_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 acceptors" do
+      resp_data = [acceptor_json(acceptor_data).merge(:relationships => acceptor_rel(acceptor_data))]
+
+      flapjack.given("an acceptor exists").
+        upon_receiving("a GET request for all acceptors").
+        with(:method => :get, :path => '/acceptors').
+        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.acceptors
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "submits a GET request for one acceptor" do
+      resp_data = acceptor_json(acceptor_data).merge(:relationships => acceptor_rel(acceptor_data))
+
+      flapjack.given("an acceptor exists").
+        upon_receiving("a GET request for a single acceptor").
+        with(:method => :get, :path => "/acceptors/#{acceptor_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.acceptors(acceptor_data[:id])
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "submits a GET request for several acceptors" do
+      resp_data = [
+        acceptor_json(acceptor_data).merge(:relationships => acceptor_rel(acceptor_data)),
+        acceptor_json(acceptor_2_data).merge(:relationships => acceptor_rel(acceptor_2_data))
+      ]
+
+      acceptors_data = [acceptor_data.merge(:type => 'acceptor'), acceptor_2_data.merge(:type => 'acceptor')]
+
+      flapjack.given("two acceptors exist").
+        upon_receiving("a GET request for two acceptors").
+        with(:method => :get, :path => "/acceptors",
+             :query => "filter%5B%5D=id%3A#{acceptor_data[:id]}%7C#{acceptor_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.acceptors(acceptor_data[:id], acceptor_2_data[:id])
+      expect(result).not_to be_nil
+      expect(result).to eq(resultify(resp_data))
+    end
+
+    it "can't find the acceptor to read" do
+      flapjack.given("no data exists").
+        upon_receiving("a GET request for a single acceptor").
+        with(:method => :get, :path => "/acceptors/#{acceptor_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 Acceptor record, id: '#{acceptor_data[:id]}'"
+            }]}
+          )
+
+      result = Flapjack::Diner.acceptors(acceptor_data[:id])
+      expect(result).to be_nil
+      expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+        :detail => "could not find Acceptor record, id: '#{acceptor_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 an acceptor' do
+  #     flapjack.given("an acceptor exists").
+  #       upon_receiving("a PUT request for a single acceptor").
+  #       with(:method => :put,
+  #            :path => "/acceptors/#{acceptor_data[:id]}",
+  #            :body => {:acceptors => {:id => acceptor_data[:id], :time_restrictions => []}},
+  #            :headers => {'Content-Type' => 'application/vnd.api+json'}).
+  #       will_respond_with(
+  #         :status => 204,
+  #         :body => '' )
+
+  #     result = Flapjack::Diner.update_acceptors(:id => acceptor_data[:id], :time_restrictions => [])
+  #     expect(result).to be_a(TrueClass)
+  #   end
+
+  #   it 'submits a PUT request for several acceptors' do
+  #     flapjack.given("two acceptors exist").
+  #       upon_receiving("a PUT request for two acceptors").
+  #       with(:method => :put,
+  #            :path => "/acceptors/#{acceptor_data[:id]},#{acceptor_2_data[:id]}",
+  #            :body => {:acceptors => [{:id => acceptor_data[:id], :time_restrictions => []},
+  #            {:id => acceptor_2_data[:id], :enabled => true}]},
+  #            :headers => {'Content-Type' => 'application/vnd.api+json'}).
+  #       will_respond_with(
+  #         :status => 204,
+  #         :body => '' )
+
+  #     result = Flapjack::Diner.update_acceptors(
+  #       {:id => acceptor_data[:id], :time_restrictions => []},
+  #       {:id => acceptor_2_data[:id], :enabled => true})
+  #     expect(result).to be_a(TrueClass)
+  #   end
+
+  #   it "can't find the acceptor to update" do
+  #     flapjack.given("no data exists").
+  #       upon_receiving("a PUT request for a single acceptor").
+  #       with(:method => :put,
+  #            :path => "/acceptors/#{acceptor_data[:id]}",
+  #            :body => {:acceptors => {:id => acceptor_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 Acceptor records, ids: '#{acceptor_data[:id]}'"
+  #           }]}
+  #         )
+
+  #     result = Flapjack::Diner.update_acceptors(:id => acceptor_data[:id], :time_restrictions => [])
+  #     expect(result).to be_nil
+  #     expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+  #       :detail => "could not find Acceptor records, ids: '#{acceptor_data[:id]}'"}])
+  #   end
+  # end
+
+  context 'delete' do
+
+    it "submits a DELETE request for an acceptor" do
+      flapjack.given("an acceptor exists").
+        upon_receiving("a DELETE request for a single acceptor").
+        with(:method => :delete,
+             :path => "/acceptors/#{acceptor_data[:id]}",
+             :body => nil).
+        will_respond_with(:status => 204,
+                          :body => '')
+
+      result = Flapjack::Diner.delete_acceptors(acceptor_data[:id])
+      expect(result).to be_a(TrueClass)
+    end
+
+    it "submits a DELETE request for several acceptors" do
+      acceptors_data = [{:type => 'acceptor', :id => acceptor_data[:id]},
+                    {:type => 'acceptor', :id => acceptor_2_data[:id]}]
+
+      flapjack.given("two acceptors exist").
+        upon_receiving("a DELETE request for two acceptors").
+        with(:method => :delete,
+             :headers => {'Content-Type' => 'application/vnd.api+json; ext=bulk'},
+             :path => "/acceptors",
+             :body => {:data => acceptors_data}).
+        will_respond_with(:status => 204,
+                          :body => '')
+
+      result = Flapjack::Diner.delete_acceptors(acceptor_data[:id], acceptor_2_data[:id])
+      expect(result).to be_a(TrueClass)
+    end
+
+    it "can't find the acceptor to delete" do
+      flapjack.given("no data exists").
+        upon_receiving("a DELETE request for a single acceptor").
+        with(:method => :delete,
+             :path => "/acceptors/#{acceptor_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 Acceptor record, id: '#{acceptor_data[:id]}'"
+            }]}
+          )
+
+      result = Flapjack::Diner.delete_acceptors(acceptor_data[:id])
+      expect(result).to be_nil
+      expect(Flapjack::Diner.last_error).to eq([{:status => '404',
+        :detail => "could not find Acceptor record, id: '#{acceptor_data[:id]}'"}])
+    end
+  end
+
+end