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

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.rb

@@ -1,46 +1,75 @@
 require 'httparty'
 require 'json'
 
+require 'flapjack-diner/log_formatter'
 require 'flapjack-diner/version'
 require 'flapjack-diner/argument_validator'
+require 'flapjack-diner/index_range'
 
-%w(acceptors checks contacts events maintenance_periods media metrics rejectors
-   states statistics tags relationships).each do |resource|
-  require "flapjack-diner/resources/#{resource}"
-end
-
+require 'flapjack-diner/resources'
+require 'flapjack-diner/relationships'
 require 'flapjack-diner/tools'
 
+# HTTParty master contains a non-hacky way of doing this, but 0.13.5 doesn't
+module HTTParty
+  module Logger
+    def self.build(logger, level, formatter)
+      level ||= :info
+      formatter ||= :apache
+
+      case formatter
+      when :'flapjack-diner'
+        Flapjack::Diner::LogFormatter.new(logger, level)
+      when :curl
+        Logger::CurlLogger.new(logger, level)
+      else
+        Logger::ApacheLogger.new(logger, level)
+      end
+    end
+  end
+end
+
 # NB: clients will need to handle any exceptions caused by,
 # e.g., network failures or non-parseable JSON data.
-
 module Flapjack
 
   # Top level module for Flapjack::Diner API consumer.
   module Diner
+    UUID_RE = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
+
     include HTTParty
     format :json
 
-    UUID_RE = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
-
     class << self
-      attr_accessor :logger, :return_keys_as_strings
-
-      include Flapjack::Diner::Resources::Acceptors
-      include Flapjack::Diner::Resources::Checks
-      include Flapjack::Diner::Resources::Contacts
-      include Flapjack::Diner::Resources::Events
-      include Flapjack::Diner::Resources::MaintenancePeriods
-      include Flapjack::Diner::Resources::Media
-      include Flapjack::Diner::Resources::Metrics
-      include Flapjack::Diner::Resources::Rejectors
-      include Flapjack::Diner::Resources::States
-      include Flapjack::Diner::Resources::Statistics
-      include Flapjack::Diner::Resources::Tags
-
-      include Flapjack::Diner::Resources::Relationships
-
-      include Flapjack::Diner::Tools
+      attr_accessor :return_keys_as_strings
+
+      # redefine HTTParty logger methods for getter/setter style
+      alias :original_logger :logger
+      def logger=(lgr)
+        original_logger(lgr, :info, :'flapjack-diner')
+      end
+      def logger
+        default_options[:logger]
+      end
+
+      def output
+        return if !instance_variable_defined?('@response') || @response.nil?
+        @response.output
+      end
+
+      def context
+        return if !instance_variable_defined?('@response') || @response.nil?
+        @response.context
+      end
+
+      def error
+        return if !instance_variable_defined?('@response') || @response.nil?
+        @response.error
+      end
     end
+
+    include Flapjack::Diner::Resources
+    include Flapjack::Diner::Relationships
+    include Flapjack::Diner::Tools
   end
 end

data/lib/flapjack-diner/argument_validator.rb

@@ -111,14 +111,6 @@ module Flapjack
       end
     end
 
-    def singular_link(*elements)
-      elements.each do |element|
-        target = @query[element]
-        next if target.nil? || (target.is_a?(String) && !target.empty?)
-        @errors << "'#{target}' association must be a String ID."
-      end
-    end
-
     def singular_link_uuid(*elements)
       elements.each do |element|
         target = @query[element]
@@ -128,15 +120,6 @@ module Flapjack
       end
     end
 
-    def multiple_link(*elements)
-      elements.each do |element|
-        target = @query[element]
-        next if target.nil? || (target.is_a?(Array) &&
-          target.all? {|t| t.is_a?(String) && !t.empty? })
-        @errors << "'#{target}' association must be an Array of String IDs."
-      end
-    end
-
     def multiple_link_uuid(*elements)
       elements.each do |element|
         target = @query[element]

data/lib/flapjack-diner/configuration.rb

@@ -0,0 +1,417 @@
+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,
+              :initial_failure_delay  => :positive_integer,
+              :repeat_failure_delay   => :positive_integer,
+              :initial_recovery_delay => :positive_integer,
+              :tags                   => :multiple_link_uuid
+            },
+            :get => RESOURCES_GET,
+            :patch => {
+              :id                     => [:required, :uuid],
+              :name                   => :non_empty_string,
+              :enabled                => :boolean,
+              :initial_failure_delay  => :positive_integer,
+              :repeat_failure_delay   => :positive_integer,
+              :initial_recovery_delay => :positive_integer,
+              :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,
+              :tags              => :multiple_link_uuid
+            },
+            :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,
+              :condition     => :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