flapjack-diner 0.12 → 0.15

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+.rbenv-version
+.ruby-version
+.rvmrc

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
 script: "bundle exec rspec"

data/README.md

@@ -524,9 +524,9 @@ Returns a boolean value representing the success or otherwise of the creation of
 Delete a scheduled maintenance period for a check on an entity:
 
 ```ruby
-# end_time (Time object, optional)
+# start_time (Time object, required)
 Flapjack::Diner.delete_scheduled_maintenance!('example.com', 'ping',
-  :end_time => Time.local(2012, 12, 01))
+  :start_time => Time.local(2012, 12, 01))
 ```
 
 Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.
@@ -536,9 +536,9 @@ Returns a boolean value representing the success or otherwise of the deletion of
 Delete a scheduled maintenance period for all checks on some entities and specified checks on others.
 
 ```ruby
-# end_time (Time object, optional)
+# start_time (Time object, required)
 Flapjack::Diner.bulk_delete_scheduled_maintenance!(:check => {'example.com' => ['ping', 'ssh']},
-  :end_time => Time.local(2012, 12, 01))
+  :start_time => Time.local(2012, 12, 01))
 ```
 
 Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.

data/lib/flapjack-diner.rb

@@ -31,9 +31,8 @@ module Flapjack
 
       def status(entity, options = {})
         check = options.delete(:check)
-        args = options.merge( check ? {:check => {entity => check}} : {:entity => entity} )
-        validate_bulk_params(args)
-        perform_get('/status', args)
+        path = check.nil? ? "/status/#{escape(entity)}" : "/status/#{escape(entity)}/#{escape(check)}"
+        perform_get(path)
       end
 
       def bulk_status(options = {})
@@ -120,13 +119,13 @@ module Flapjack
 
       def scheduled_maintenances(entity, options = {})
         check = options.delete(:check)
-        args = options.merge( check ? {:check => {entity => check}} : {:entity => entity} )
 
-        validate_bulk_params(args) do
+        validate_params(options) do
           validate :query => [:start_time, :end_time], :as => :time
         end
 
-        perform_get('/scheduled_maintenances', args)
+        ec_path = entity_check_path(entity, check)
+        perform_get("/scheduled_maintenances/#{ec_path}", options)
       end
 
       def bulk_scheduled_maintenances(options = {})
@@ -139,13 +138,13 @@ module Flapjack
 
       def unscheduled_maintenances(entity, options = {})
         check = options.delete(:check)
-        args = options.merge( check ? {:check => {entity => check}} : {:entity => entity} )
 
-        validate_bulk_params(args) do
+        validate_params(options) do
           validate :query => [:start_time, :end_time], :as => :time
         end
 
-        perform_get('/unscheduled_maintenances', args)
+        ec_path = entity_check_path(entity, check)
+        perform_get("/unscheduled_maintenances/#{ec_path}", options)
       end
 
       def bulk_unscheduled_maintenances(options = {})
@@ -158,13 +157,13 @@ module Flapjack
 
       def outages(entity, options = {})
         check = options.delete(:check)
-        args = options.merge( check ? {:check => {entity => check}} : {:entity => entity} )
 
-        validate_bulk_params(args) do
+        validate_params(options) do
           validate :query => [:start_time, :end_time], :as => :time
         end
 
-        perform_get('/outages', args)
+        ec_path = entity_check_path(entity, check)
+        perform_get("/outages/#{ec_path}", options)
       end
 
       def bulk_outages(options = {})
@@ -177,13 +176,14 @@ module Flapjack
 
       def downtime(entity, options = {})
         check = options.delete(:check)
-        args = options.merge( check ? {:check => {entity => check}} : {:entity => entity} )
 
-        validate_bulk_params(args) do
+        validate_params(options) do
           validate :query => [:start_time, :end_time], :as => :time
         end
 
-        perform_get('/downtime', args)
+        ec_path = entity_check_path(entity, check)
+
+        perform_get("/downtime/#{ec_path}", options)
       end
 
       def bulk_downtime(options = {})
@@ -341,7 +341,8 @@ module Flapjack
         response_body = response.body
         response_start = response_body ? response_body[0..300] : nil
         if logger
-          logger.info "  Response Code: #{response.code}#{response.message ? response.message : ''}"
+          response_message = " #{response.message}" unless (response.message.nil? || response.message == "")
+          logger.info "  Response Code: #{response.code}#{response_message}"
           logger.info "  Response Body: #{response_start}" if response_start
         end
         parsed_response = response.respond_to?(:parsed_response) ? response.parsed_response : nil
@@ -374,9 +375,17 @@ module Flapjack
           raise ArgumentError.new("Entity and/or check arguments must be provided")
         end
 
+        validate_params(query, &validation)
+      end
+
+      def validate_params(query = {}, &validation)
         ArgumentValidator.new(query).instance_eval(&validation) if block_given?
       end
 
+      def entity_check_path(entity, check)
+        check.nil? ? "#{escape(entity)}" : "#{escape(entity)}/#{escape(check)}"
+      end
+
       # copied from Rack::Utils -- builds the query string for GETs
       def build_nested_query(value, prefix = nil)
         if value.respond_to?(:iso8601)

data/lib/flapjack-diner/argument_validator.rb

@@ -28,7 +28,9 @@ module Flapjack
     def time(*elements)
       elements.each do |element|
         if target = @query[element]
-          @errors << "'#{target}' should contain some kind of time object which responds to." unless target.respond_to?(:iso8601)
+          next if target.respond_to?(:iso8601) || (target.is_a?(String) &&
+            (begin; Time.iso8601(target); true; rescue ArgumentError; false; end))
+          @errors << "'#{target}' should be a time object or ISO 8601-formatted string."
         end
       end
     end

data/lib/flapjack-diner/version.rb

@@ -1,5 +1,5 @@
 module Flapjack
   module Diner
-    VERSION = "0.12"
+    VERSION = "0.15"
   end
 end

data/spec/argument_validator_spec.rb

@@ -61,6 +61,16 @@ describe Flapjack::ArgumentValidator do
       query[:end_time] = Date.today
       lambda { subject.validate(:query => :end_time, :as => :time) }.should_not raise_exception(ArgumentError)
     end
+
+    it 'handles ISO 8601 strings as query values' do
+      query[:end_time] = Time.now.iso8601
+      lambda { subject.validate(:query => :end_time, :as => :time) }.should_not raise_exception(ArgumentError)
+    end
+
+    it 'raises an exception when invalid time strings are provided' do
+      query[:end_time] = '2011-08-01T00:00'
+      lambda { subject.validate(:query => :end_time, :as => :time) }.should raise_exception(ArgumentError)
+    end
   end
 
   context 'integer via method missing' do

data/spec/flapjack-diner_spec.rb

@@ -68,6 +68,16 @@ describe Flapjack::Diner do
             with(:query => {:entity => entity}).
             to_return(:body => response)
 
+    result = Flapjack::Diner.bulk_status(:entity => entity)
+    req.should have_been_requested
+    result.should_not be_nil
+    result.should == response_body
+  end
+
+  it "returns a json list of check statuses for an entity, legacy" do
+    req = stub_request(:get, "http://#{server}/status/#{entity}").
+            to_return(:body => response)
+
     result = Flapjack::Diner.status(entity)
     req.should have_been_requested
     result.should_not be_nil
@@ -90,6 +100,16 @@ describe Flapjack::Diner do
             with(:query => {:check => {entity => check}}).
             to_return(:body => response)
 
+    result = Flapjack::Diner.bulk_status(:check => {entity => check})
+    req.should have_been_requested
+    result.should_not be_nil
+    result.should == response_body
+  end
+
+  it "returns a single check status for an entity, legacy" do
+    req = stub_request(:get, "http://#{server}/status/#{entity}/#{check}").
+            to_return(:body => response)
+
     result = Flapjack::Diner.status(entity, :check => check)
     req.should have_been_requested
     result.should_not be_nil
@@ -97,8 +117,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of scheduled maintenance periods for all checks on an entity" do
-    req = stub_request(:get, "http://#{server}/scheduled_maintenances").
-            with(:query => {:entity => entity}).
+    req = stub_request(:get, "http://#{server}/scheduled_maintenances/#{entity}").
             to_return(:body => response)
 
     result = Flapjack::Diner.scheduled_maintenances(entity)
@@ -108,8 +127,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of scheduled maintenance periods for a check on an entity" do
-    req = stub_request(:get, "http://#{server}/scheduled_maintenances").
-            with(:query => {:check => {entity => check}}).
+    req = stub_request(:get, "http://#{server}/scheduled_maintenances/#{entity}/#{check}").
             to_return(:body => response)
 
     result = Flapjack::Diner.scheduled_maintenances(entity, :check => check)
@@ -130,8 +148,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of unscheduled maintenance periods for all checks on an entity" do
-    req = stub_request(:get, "http://#{server}/unscheduled_maintenances").
-            with(:query => {:entity => entity}).
+    req = stub_request(:get, "http://#{server}/unscheduled_maintenances/#{entity}").
             to_return(:body => response)
 
     result = Flapjack::Diner.unscheduled_maintenances(entity)
@@ -141,8 +158,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of unscheduled maintenance periods for a check on an entity" do
-    req = stub_request(:get, "http://#{server}/unscheduled_maintenances").
-            with(:query => {:check => {entity => check}}).
+    req = stub_request(:get, "http://#{server}/unscheduled_maintenances/#{entity}/#{check}").
             to_return(:body => response)
 
     result = Flapjack::Diner.unscheduled_maintenances(entity, :check => check)
@@ -163,8 +179,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of outages for all checks on an entity" do
-    req = stub_request(:get, "http://#{server}/outages").
-            with(:query => {:entity => entity}).
+    req = stub_request(:get, "http://#{server}/outages/#{entity}").
             to_return(:body => response)
 
     result = Flapjack::Diner.outages(entity)
@@ -174,8 +189,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of outages for a check on an entity" do
-    req = stub_request(:get, "http://#{server}/outages").
-            with(:query => {:check => {entity => check}}).
+    req = stub_request(:get, "http://#{server}/outages/#{entity}/#{check}").
             to_return(:body => response)
 
     result = Flapjack::Diner.outages(entity, :check => check)
@@ -196,8 +210,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of downtimes for all checks on an entity" do
-    req = stub_request(:get, "http://#{server}/downtime").
-            with(:query => {:entity => entity}).
+    req = stub_request(:get, "http://#{server}/downtime/#{entity}").
             to_return(:body => response)
 
     result = Flapjack::Diner.downtime(entity)
@@ -210,8 +223,8 @@ describe Flapjack::Diner do
     start  = Time.iso8601('2011-08-01T00:00:00+10:00')
     finish = Time.iso8601('2011-08-31T00:00:00+10:00')
 
-    req = stub_request(:get, "http://#{server}/downtime").
-            with(:query => {:entity => entity, :start_time => start.iso8601, :end_time => finish.iso8601}).
+    req = stub_request(:get, "http://#{server}/downtime/#{entity}").
+            with(:query => {:start_time => start.iso8601, :end_time => finish.iso8601}).
             to_return(:body => response)
 
     result = Flapjack::Diner.downtime(entity, :start_time => start, :end_time => finish)
@@ -221,8 +234,7 @@ describe Flapjack::Diner do
   end
 
   it "returns a list of downtimes for a check on an entity" do
-    req = stub_request(:get, "http://#{server}/downtime").
-            with(:query => {:check => {entity => check}}).
+    req = stub_request(:get, "http://#{server}/downtime/#{entity}/#{check}").
             to_return(:body => response)
 
     result = Flapjack::Diner.downtime(entity, :check => check)
@@ -774,7 +786,7 @@ describe Flapjack::Diner do
       timezone_data = {:timezone => "Australia/Perth"}
 
       req = stub_request(:put, "http://#{server}/contacts/#{contact_id}/timezone").with(
-        :body => timezone_data).to_return(:body => timezone_data.to_json, :status => [200, ' OK'])
+        :body => timezone_data).to_return(:body => timezone_data.to_json, :status => [200, 'OK'])
 
       logger.should_receive(:info).
         with("PUT http://#{server}/contacts/#{contact_id}/timezone\n  Params: #{timezone_data.inspect}")
@@ -860,7 +872,7 @@ describe Flapjack::Diner do
 
     it "raises an exception if a time argument is provided with the wrong data type" do
       start_str  = '2011-08-01T00:00:00+10:00'
-      finish_str = '2011-08-31T00:00:00+10:00'
+      finish_str = 'yesterday'
 
       start  = Time.iso8601(start_str)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack-diner
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.15'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -131,7 +131,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rbenv-version
 - .rspec
 - .travis.yml
 - Gemfile
@@ -157,18 +156,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2019754927088119775
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2019754927088119775
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/.rbenv-version

@@ -1 +0,0 @@
-1.9.3-p125