flapjack-diner 1.4.0 → 2.0.0.a4

data/flapjack-diner.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Flapjack::Diner::VERSION
 
-  gem.add_dependency('httparty', '>= 0.10')
+  gem.add_dependency('httparty', '= 0.13.5')
   gem.add_dependency('json', '>= 1.7.7')
 end

data/lib/flapjack-diner/argument_validator.rb

@@ -31,13 +31,21 @@ module Flapjack
       false
     end
 
+    def uuid(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target =~ /^#{Flapjack::Diner::UUID_RE}$/i)
+        @errors << "'#{target}' must be a RFC 4122-compliant UUID."
+      end
+    end
+
     def time(*elements)
       elements.each do |element|
         target = @query[element]
         next if target.nil? || target.respond_to?(:iso8601) ||
           (target.is_a?(String) && valid_time_str?(target))
-        @errors << "'#{target}' should be a time object or ISO " \
-                   '8601-formatted string.'
+        @errors << "'#{target}' must be a time object or ISO " \
+                   '8601-formatted String.'
       end
     end
 
@@ -45,23 +53,85 @@ module Flapjack
       elements.each do |element|
         target = @query[element]
         next if target.nil? || [TrueClass, FalseClass].include?(target.class)
-        @errors << "'#{target}' should be 'true' or 'false'."
+        @errors << "'#{target}' must be 'true' or 'false'."
+      end
+    end
+
+    def positive_integer(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(Integer) && (target > 0))
+        @errors << "'#{target}' must be an Integer greater than 0."
+      end
+    end
+
+    def non_empty_string(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(String) && !target.empty?)
+        @errors << "'#{target}' must be a non-empty String."
       end
     end
 
     def array_of_strings(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(Array) && !target.empty? &&
+          target.all? {|t| t.is_a?(String) && !t.empty? })
+        @errors << "'#{target}' must be an Array of non-empty Strings."
+      end
+    end
+
+    def string_or_array_of_strings(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(String) && !target.empty?) ||
+         (target.is_a?(Array) && !target.empty? &&
+          target.all? {|t| t.is_a?(String) && !t.empty? })
+        @errors << "'#{target}' must be a non-empty String, or an Array of non-empty Strings."
+      end
+    end
+
+    def uuid_or_array_of_uuids(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(String) && (target =~ /^#{Flapjack::Diner::UUID_RE}$/i)) ||
+         (target.is_a?(Array) && !target.empty? &&
+          target.all? {|t| t.is_a?(String) && (t =~ /^#{Flapjack::Diner::UUID_RE}$/i)})
+        @errors << "'#{target}' must be a RFC 4122-compliant UUID, or an Array of RFC 4122-compliant UUIDs."
+      end
+    end
+
+    def hash(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(Hash) &&
+          target.keys.all? {|t| (t.is_a?(String) && !t.empty?) || t.is_a?(Symbol) })
+        @errors << "'#{target}' must be a Hash with String or Symbol keys."
+      end
+    end
+
+    def singular_link_uuid(*elements)
+      elements.each do |element|
+        target = @query[element]
+        next if target.nil? || (target.is_a?(String) &&
+          (target =~ /^#{Flapjack::Diner::UUID_RE}$/i))
+        @errors << "'#{target}' association must be a RFC 4122-compliant UUID."
+      end
+    end
+
+    def multiple_link_uuid(*elements)
       elements.each do |element|
         target = @query[element]
         next if target.nil? || (target.is_a?(Array) &&
-          target.all? {|t| t.is_a?(String) })
-        @errors << "'#{target}' should be an Array of Strings."
+          target.all? {|t| t =~ /^#{Flapjack::Diner::UUID_RE}$/i })
+        @errors << "'#{target}' association must be an Array of RFC 4122-compliant UUIDs."
       end
     end
 
     def required(*elements)
       elements.each do |element|
-        next unless @query[element].nil?
-        @errors << "'#{element}' is required."
+        @errors << "'#{element}' is required." if @query[element].nil?
       end
     end
 

data/lib/flapjack-diner/configuration.rb

@@ -0,0 +1,409 @@
+require 'flapjack-diner/request'
+require 'flapjack-diner/response'
+
+require 'flapjack-diner/argument_validator'
+
+module Flapjack
+  module Diner
+    module Configuration
+
+      RESOURCES_GET = {
+        [:fields, :sort, :include] => :string_or_array_of_strings,
+        :filter                    => :hash,
+        [:page, :per_page]         => :positive_integer
+      }
+
+      # relationships are extracted from flapjack data models'
+      # "jsonapi_associations" class methods
+
+      RESOURCES = {
+        :acknowledgements => {
+          :resource => 'acknowledgement',
+          :requests => {
+            :post => {
+              :duration      => :positive_integer,
+              :summary       => :non_empty_string,
+              [:check, :tag] => :singular_link_uuid
+            },
+          },
+          :request_validations => {
+            :post => proc {
+              # _events_validate_association(data, 'acknowledgement')
+            }
+          },
+          :relationships => {
+            :check => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false,
+              :resource => 'check'
+            },
+            :tag => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false,
+              :resource => 'tag'
+            }
+          }
+        },
+
+        :checks => {
+          :resource => 'check',
+          :requests => {
+            :post => {
+              :id       => :uuid,
+              :name     => [:required, :non_empty_string],
+              :enabled  => :boolean,
+              :tags     => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id       => [:required, :uuid],
+              :name     => :non_empty_string,
+              :enabled  => :boolean,
+              :tags     => :multiple_link_uuid
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :alerting_media => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'medium'
+            },
+            :contacts => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'contact'
+            },
+            :current_scheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'scheduled_maintenance'
+            },
+            :current_state => {
+              :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'state'
+            },
+            :current_unscheduled_maintenance => {
+              :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'unscheduled_maintenance'
+            },
+            :latest_notifications => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'state'
+            },
+            :scheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'scheduled_maintenance'
+            },
+            :states => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'state'
+            },
+            :tags => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'tag'
+            },
+            :unscheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'unscheduled_maintenance'
+            }
+          }
+        },
+
+        :contacts => {
+          :resource => 'contact',
+          :requests => {
+            :post => {
+              :id       => :uuid,
+              :name     => [:required, :non_empty_string],
+              :timezone => :non_empty_string,
+              :tags     => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id                => [:required, :uuid],
+              [:name, :timezone] => :non_empty_string
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :checks => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'check'
+            },
+            :media => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'medium'
+            },
+            :rules => {
+              :get => :true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'rule'
+            },
+            :tags => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'tag'
+            }
+          }
+        },
+
+        :media => {
+          :resource => 'medium',
+          :requests => {
+            :post => {
+              :id                       => :uuid,
+              :transport                => [:non_empty_string, :required],
+              [:address, :pagerduty_subdomain,
+               :pagerduty_token]        => :non_empty_string,
+              [:interval, :rollup_threshold,
+               :pagerduty_ack_duration] => :positive_integer,
+              :contact                  => [:singular_link_uuid, :required],
+              :rules                    => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id                       => [:uuid, :required],
+              [:address, :pagerduty_subdomain,
+               :pagerduty_token]        => :non_empty_string,
+              [:interval, :rollup_threshold,
+               :pagerduty_ack_duration] => :positive_integer,
+              :rules                    => :multiple_link_uuid
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :alerting_checks => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'check'
+            },
+            :contact => {
+              :post => true, :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'contact'
+            },
+            :rules => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'rule'
+            }
+          }
+        },
+
+        :metrics => {
+          :resource => 'metrics',
+          :requests => {
+            :get => {
+              :fields => :string_or_array_of_strings
+            }
+          }
+        },
+
+        :rules => {
+          :resource => 'rule',
+          :requests => {
+            :post => {
+              :id                    => :uuid,
+              :name                  => :string,
+              :enabled               => :boolean,
+              :blackhole             => :boolean,
+              :strategy              => :string,
+              :conditions_list       => :string,
+              :time_restriction_ical => :string,
+              :contact               => [:singular_link_uuid, :required],
+              [:media, :tags]        => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id                    => [:uuid, :required],
+              :name                  => :string,
+              :enabled               => :boolean,
+              :blackhole             => :boolean,
+              :strategy              => :string,
+              :conditions_list       => :string,
+              :time_restriction_ical => :string,
+              [:media, :tags]        => :multiple_link_uuid
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :contact => {
+              :post => true, :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'contact'
+            },
+            :media => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'medium'
+            },
+            :tags => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'tag'
+            }
+          }
+        },
+
+        :scheduled_maintenances => {
+          :resource => 'scheduled_maintenance',
+          :requests => {
+            :post => {
+              :id                      => :uuid,
+              [:start_time, :end_time] => [:required, :time],
+              :summary                 => :non_empty_string,
+              [:check, :tag]           => :singular_link_uuid
+            },
+            :request_validations => {
+              :post => proc {
+                # _maintenance_periods_validate_association(data, 'scheduled maintenance period')
+              }
+            },
+            :patch => {
+              :id                      => [:required, :uuid],
+              [:start_time, :end_time] => :time
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :check => {
+              :post => true, :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'check'
+            },
+            :tag => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false,
+              :resource => 'tag'
+            }
+          }
+        },
+
+        :states => {
+          :resource => 'state',
+          :requests => {
+            :get => RESOURCES_GET
+          },
+          :relationships => {
+            :check => {
+              :get => true,
+              :number => :singular, :link => true, :includable => true,
+              :resource => 'check'
+            }
+          }
+        },
+
+        :statistics => {
+          :resource => 'statistic',
+          :requests => {
+            :get => RESOURCES_GET
+          }
+        },
+
+        :tags => {
+          :resource => 'tag',
+          :requests => {
+            :post => {
+              :id                          => :uuid,
+              :name                        => [:required, :non_empty_string],
+              [:checks, :contacts, :rules] => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id                          => [:required, :uuid],
+              :name                        => :non_empty_string,
+              [:checks, :contacts, :rules] => :multiple_link_uuid
+            },
+            :delete => {}
+          },
+          :relationships => {
+            :checks => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'check'
+            },
+            :contacts => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'contact'
+            },
+            :rules => {
+              :post => true, :get => true, :patch => true, :delete => true,
+              :number => :multiple, :link => true, :includable => true,
+              :resource => 'rule'
+            },
+            :scheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'scheduled_maintenance'
+            },
+            :states => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'state'
+            },
+            :unscheduled_maintenances => {
+              :get => true,
+              :number => :multiple, :link => true, :includable => false,
+              :resource => 'unscheduled_maintenance'
+            }
+          }
+        },
+
+        :test_notifications => {
+          :resource => 'test_notification',
+          :requests => {
+            :post => {
+              :summary       => :non_empty_string,
+              [:check, :tag] => :singular_link_uuid
+            }
+          },
+          :request_validations => {
+            :post => proc {
+              # _events_validate_association(data, 'test notification')
+            }
+          },
+          :relationships => {
+            :check => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false,
+              :resource => 'check'
+            },
+            :tag => {
+              :post => true,
+              :number => :singular, :link => false, :includable => false,
+              :resource => 'tag'
+            }
+          }
+        },
+
+        :unscheduled_maintenances => {
+          :resource => 'unscheduled_maintenance',
+          :requests => {
+            :patch => {
+              :id       => [:required, :uuid],
+              :end_time => [:required, :time]
+            }
+          },
+          :relationships => {
+            :check => {
+              :get => true,
+              :number => :singular, :link => false, :includable => true,
+              :resource => 'check'
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/flapjack-diner/index_range.rb

@@ -0,0 +1,42 @@
+# fairly similar to the object in Zermelo that this ends up being translated to
+# by Flapjack's JSONAPI, although slightly limited in scope
+
+module Flapjack
+  module Diner
+    class IndexRange
+      attr_reader :start, :finish
+
+      def initialize(start, finish, opts = {})
+        value_types = [Float, Date, Time, DateTime]
+        [start, finish].each do |v|
+          raise "Values must be #{value_types.join('/')}" unless v.nil? || value_types.any? {|vt| v.is_a?(vt)}
+        end
+        if !start.nil? && !finish.nil? && (start > finish)
+          raise "Start of range must be <= finish"
+        end
+        if start.nil? && finish.nil?
+          raise "Range must be bounded on at least one side"
+        end
+        @start  = start
+        @finish = finish
+      end
+
+      # NB
+      def to_s
+        start_s = case @start
+        when Date, Time, DateTime
+          @start.iso8601
+        else
+          @start.to_s
+        end
+        finish_s = case @finish
+        when Date, Time, DateTime
+          @finish.iso8601
+        else
+          @finish.to_s
+        end
+        "#{start_s}..#{finish_s}"
+      end
+    end
+  end
+end

data/lib/flapjack-diner/log_formatter.rb

@@ -0,0 +1,22 @@
+module Flapjack
+  module Diner
+    class LogFormatter #:nodoc:
+      TAG_NAME = Flapjack::Diner.name
+
+      attr_accessor :level, :logger, :current_time
+
+      def initialize(logger, level)
+        @logger = logger
+        @level  = level.to_sym
+      end
+
+      def format(request, response)
+        current_time   = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
+        http_method    = request.http_method.name.split("::").last.upcase
+        path           = request.path.to_s
+        content_length = response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']
+        @logger.send @level, "[#{TAG_NAME}] [#{current_time}] #{response.code} \"#{http_method} #{path}\" #{content_length || '-'} "
+      end
+    end
+  end
+end