pingdom 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec0019c8887e2600c0ad0b892ebd9e00ccd427d1
-  data.tar.gz: d9f0c1b704fa686b34720798c4d2f53f440aa1e5
+  metadata.gz: 903ee6f2adac2105596099e2105ff22c8b4f681b
+  data.tar.gz: b2744b0aee1013468c80c82d5a8d379722bcac79
 SHA512:
-  metadata.gz: 3e2cdb42f5084b038f8ccba8f03fa6d5bfb09893b0dde8576fb076269485930ed80092a06c8811895d8f3aca041e724661c9483ae88fc69c06fe0cbfeef86ced
-  data.tar.gz: 5d9fd6ddfca6d3fde03125758c94032f5563b867d269d9773e21837152baae904e85cf952162d28a568df4c0197591bf3baa9b8f7a63ae18634ab9efc90bb101
+  metadata.gz: 1f68477de6fb1fab126a899c48c30eb20fadfad26b7ac2f7b91e1e608dd15f4360f0d62c6acbd65afbe58fa0ad47dd0bcebf1f8934b168139c02ab5a52ff4b6e
+  data.tar.gz: 9d3cbcb180811f3bb49f9c718b562e6ed553bc7522aa0881e5d6a4483b53d75923e18a556de6d47fc166fae318a08364a7e6e84f19efdd3fc22ad2afd5a396d5

data/README.md

@@ -55,8 +55,74 @@ checks.each do |check|
 To get one check using find, you need the id
 
 ```ruby
-check = Pingom::Check.find 85975
+check = Pingdom::Check.find 85975
 # return a check or raise an error if the chech is not found
+
+# with tags
+check = Pingdom::Check.find 85975, include_tags: true
+```
+
+### Summary Average
+
+Get the Sumary Average by check id:
+
+```ruby
+average = Pingdom::SummaryAverage.find check_id
+
+average.from # is a Time
+=> 1970-01-01 01:00:00 +0100
+
+average.to # is a Time
+=> 2017-09-05 15:43:53 +0100
+
+average.avgresponse # is a Integer
+=> 381
+
+# with parameters
+
+average = Pingdom::SummaryAverage.find check_id, from: 10.days.ago , to: 1.day.ago, probes: '44,33'
+
+# includeuptime
+
+average = Pingdom::SummaryAverage.find check_id, includeuptime: true
+# get status data
+average.status.totalup
+average.status.totaldown
+average.status.totalunknown
+
+# bycountry
+
+average = Pingdom::SummaryAverage.find check_id, bycountry: true
+
+average.avgresponse # is an Array of Struct::AvgResponse
+r = average.avgresponse.firt
+r.country
+=> 'UK'
+
+r.avgresponse
+=> 92
+
+r.from # and r.to are Times
+=> 1970-01-01 01:00:00 +0100
+
+# byprobe
+
+average = Pingdom::SummaryAverage.find check_id, byprobe: true
+a=average.probe_responses # is array of Struct::ProbeResponse
+
+# Get data of each probe response
+r=a.first
+r.id # the id of the probe
+r.avgresponse
+r.n # integer
+r.from
+r.to
+
+average.from # Time of request filter
+=> 1970-01-01 01:00:00 +0100
+average.to # Time of request filter
+=> 2017-09-05 15:43:53 +0100
+
 ```
 
 ### Summary Outages
@@ -69,7 +135,7 @@ summary_outage = Pingdom::SummaryOutage.find check_id
 
 # With params from, to and order are not mandatory params
 
-summary_outage = Pingdom::SummaryOutage.find check_id , from: 2.days.ago, to: 1.days.ago, order: 'ask'
+summary_outage = Pingdom::SummaryOutage.find check_id , from: 2.days.ago, to: 1.days.ago, order: 'desc'
 
 # get up and down times
 summary_outage.ups
@@ -87,6 +153,44 @@ summary_outage.downs min_interval: 180 # more than 3 minutes
 
 ```
 
+### Summary Performance
+
+Get the Summary Performance by check id:
+
+```ruby
+
+summary_performance= Pingodm::SummaryPerformance find check_id
+
+# available params from: Time , to: Time, resolution: 'hour' | 'day'| 'week' , includeuptime: true | false
+
+# When you find by a hour resolution you can get hours
+summary_performance.hours.each do |h|
+  puts h.starttime # Time
+  puts h.avgresponse # Integer
+  puts h.uptime # Integer
+  puts h.downtime # Integer
+  puts h.unmonitored # Integer
+end
+
+# the same behavior with 'week' and 'day' resolutions, you can get the data of each one use the same methods.
+
+summary_performance.weeks.is_a
+=> Array # of Struct::Week
+
+summary_performance.day.is_a
+=> Array # of Struct::Day
+
+```
+
+### ServerTime
+
+Easy way to get the servertime
+
+```ruby
+Pingdom::ServerTime.time
+=> 2017-09-05 17:47:56 +0100 #Time object of the servertime
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pingdom/base.rb

@@ -1,4 +1,7 @@
+require 'json'
+
 module Pingdom
+
   class Base
 
     @@client = Client.new

data/lib/pingdom/check.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module Pingdom
 
   class Check < Pingdom::Base

data/lib/pingdom/server_time.rb

@@ -0,0 +1,38 @@
+module Pingdom
+
+  class ServerTime < Pingdom::Base
+
+    class << self
+
+      def path
+        '/servertime'
+      end
+
+      def get
+        parse client.get( path: path )
+
+        if body.include?('servertime')
+          server_time=self.new body
+        end
+
+        server_time
+
+      end
+
+      def time
+        get.servertime
+      end
+
+
+    end
+
+    attr_accessor :servertime
+
+    private
+
+      def time_attributes
+        %q{servertime}
+      end
+
+  end
+end

data/lib/pingdom/summary_average.rb

@@ -0,0 +1,56 @@
+module Pingdom
+
+  Struct.new('AvgResponse',:countryiso, :avgresponse)
+  Struct.new('ProbeResponse',:id, :avgresponse,:from,:n, :to)
+
+  class SummaryAverage < Pingdom::Base
+
+    class << self
+
+      def path
+        '/summary.average'
+      end
+
+      def collection_type
+        'summary'
+      end
+
+      def permit
+        {
+          to: :valid_time?,
+          from: :valid_time?,
+          probes: :valid_int_list?,
+          includeuptime: :valid_boolean?,
+          bycountry: :valid_boolean?,
+          byprobe: :valid_boolean?
+        }
+      end
+
+    end
+
+    attr_accessor :responsetime, :status, :probe_responses
+
+    def avgresponse
+      data = responsetime['avgresponse'] || []
+      data.map do |v|
+        Struct::AvgResponse.new(v['countryiso'], v['avgresponse'])
+      end
+    end
+
+    def probe_responses
+      responsetime.each_pair.map do |k,v|
+        next if %q(from to).include?(k)
+        Struct::ProbeResponse.new(k.to_i,v['avgresponse'],Time.at(v['from']),v['n'], Time.at(v['to']))
+      end
+    end
+
+    def from
+      Time.at responsetime['from']
+    end
+
+    def to
+      Time.at responsetime['to']
+    end
+
+  end
+end

data/lib/pingdom/summary_outage.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module Pingdom
 
   Struct.new('State',:status, :timefrom, :timeto) do

data/lib/pingdom/summary_performance.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module Pingdom
 
   Struct.new('Week',:starttime, :avgresponse, :uptime, :downtime, :unmonitored)
@@ -25,7 +23,7 @@ module Pingdom
           from: :valid_time?,
           resolution: :valid_resolution?,
           order: :valid_order?,
-          includeuptime: :valid_boolean_str?
+          includeuptime: :valid_boolean?
         }
       end
 

data/lib/pingdom/validator.rb

@@ -28,6 +28,7 @@ module Pingdom
     def format
       validate_all.each_pair.map do |key, value|
         value=value.to_i if permit[key]==:valid_time?
+        value=value.to_s if permit[key]==:valid_boolean?
         [key, value]
       end.to_h
     end
@@ -48,8 +49,8 @@ module Pingdom
       %q(hour day week).include? resolution
     end
 
-    def valid_boolean_str? boolstring
-      ['true','false'].include? boolstring
+    def valid_boolean? bool
+      bool.is_a?(TrueClass) || bool.is_a?(FalseClass)
     end
 
     def valid_int_list? int_list

data/lib/pingdom/version.rb

@@ -1,3 +1,3 @@
 module Pingdom
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/pingdom.rb

@@ -5,7 +5,9 @@ require "pingdom/base"
 require 'pingdom/check'
 require 'pingdom/summary_outage'
 require 'pingdom/summary_performance'
+require 'pingdom/summary_average'
 require 'pingdom/validator'
+require 'pingdom/server_time'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/core_ext/time/acts_like'
 require 'active_support/core_ext/time/calculations'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pingdom
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Diego Piccinini Lagos
@@ -129,6 +129,8 @@ files:
 - lib/pingdom/base.rb
 - lib/pingdom/check.rb
 - lib/pingdom/client.rb
+- lib/pingdom/server_time.rb
+- lib/pingdom/summary_average.rb
 - lib/pingdom/summary_outage.rb
 - lib/pingdom/summary_performance.rb
 - lib/pingdom/validator.rb