updown 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae7726d29d3ab3d38259054cdab774e129640a24
-  data.tar.gz: c5ddc78ed903615481aad4d0fe8a1c306eebd6fd
+  metadata.gz: 11ad73d000351864816dc649ba37815d432f9dba
+  data.tar.gz: 4d38bdc654d9a62fc14d697811a579937afb2463
 SHA512:
-  metadata.gz: 6d1b87d64a6190c1e29381ce067754cf47c377f1496c3ad9a3b631b257e8e3e538fd47ea2d69c023126dbd1238705de1d9c9a641a5440754e81c439afdb910a8
-  data.tar.gz: f968ad6072e94d9eb1f75f7a4cf1bbcd40768c9de21cb4892427fc56f096124a0481ec5c5c6850b99bbd0dcc2c7703b0aa1d43fb94f7b2971c38603433867357
+  metadata.gz: f5c7d7112b065d20fdaf5b626109bd4bf282f2ea833a1a75749ce6a0c4b2b735e8ef5bcb8dfef6df5f9d0bf535786e76daef73a182f945e1dbd83955b3ea8fa8
+  data.tar.gz: ce936d0df39b4cd0393bd702c4551b88bb7ca1d25358cc179430ec9efb8e09c37ac9df82648283ca3d14d45a06351bcc3084bb63372574f0cefacb01d826ce46

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.4.0
+_2016-06-05_
+
+* Added support for the check/:token/metrics endpoint
+* Added support for the metrics parameter to the check/:token endpoint
+
 ### 0.2.2
 _2015-06-28_
 

data/README.md

@@ -45,6 +45,11 @@ Retrieve a specific check:
 ```ruby
 Updown::Check.get check_token
 # => <Updown::Check>
+
+# include performance metrics for the last hour
+check = Updown::Check.get check_token, metrics: true
+check.metrics
+# => {"apdex": 0.98, "requests": { … }, "timings": { … }}
 ```
 
 List downtimes for a specific check (paginated, 100 per call):
@@ -57,6 +62,27 @@ check.downtimes page: 2
 # => [<Updown::Downtime>]
 ```
 
+Get detailed performance metrics for a specific check:
+
+```ruby
+# Default is for last month
+check.get_metrics
+# => {"apdex": 0.98, "requests": { … }, "timings": { … }}
+
+# Specify time span
+check.get_metrics from: 4.hours.ago, to: 2.hours.ago
+# => {"apdex": 1, "requests": { … }, "timings": { … }}
+
+# Specify grouping per location (:host) or hour (:time)
+check.get_metrics group: :host
+# => {
+#   "sgp" => {"apdex": 0.82, "host": { city: "Singapore", … }, … },
+#   "sfo" => {"apdex": 0.98, "host": { city: "San Francisco", … }, … },
+#   "alpha" => {"apdex": 0.98, "host": { city: "Montreal", … }, … },
+#   "gra" => {"apdex": 0.92, "host": { city: "Gravelines", … }, … }
+# }
+```
+
 Create a new check:
 
 ```ruby

data/lib/updown/call.rb

@@ -17,12 +17,16 @@ module Updown
       process { Call.resource["checks/#{token}/downtimes"].get(params: filters) }
     end
 
+    def self.metrics(token, filters={})
+      process { Call.resource["checks/#{token}/metrics"].get(params: filters) }
+    end
+
     def self.create_check(attributes={})
       process { Call.resource['checks'].post(attributes) }
     end
 
     def self.get_check(token, attributes={})
-      process { Call.resource["checks/#{token}"].get(attributes) }
+      process { Call.resource["checks/#{token}"].get(params: attributes) }
     end
 
     def self.update_check(token, attributes={})
@@ -37,7 +41,7 @@ module Updown
       JSON.parse yield
     rescue RestClient::BadRequest, RestClient::Unauthorized, RestClient::ResourceNotFound => e
       result = (JSON.parse(e.response) rescue {})
-      raise Updown::Error.new(result['error'] || e.reponse)
+      raise Updown::Error.new(result['error'] || e.response)
     end
 
   end

data/lib/updown/check.rb

@@ -2,7 +2,7 @@ require 'time'
 
 module Updown
   class Check
-    attr_accessor :token, :url, :alias, :last_status, :uptime, :down, :down_since, :error, :period, :apdex_t, :enabled, :published, :last_check_at, :next_check_at, :ssl_tested_at, :ssl_valid, :ssl_error
+    attr_accessor :token, :url, :alias, :last_status, :uptime, :down, :down_since, :error, :period, :apdex_t, :enabled, :published, :last_check_at, :next_check_at, :ssl_tested_at, :ssl_valid, :ssl_error, :metrics
 
     def self.all
       Updown::Call.checks.map do |check|
@@ -30,6 +30,7 @@ module Updown
       @uptime        = json['uptime']
       @down          = json['down']
       @error         = json['error']
+      @metrics       = json['metrics']
       @down_since    = Time.parse(json['down_since']) if json['down_since']
       @last_check_at = Time.parse(json['last_check_at']) if json['last_check_at']
       @next_check_at = Time.parse(json['next_check_at']) if json['next_check_at']
@@ -44,6 +45,10 @@ module Updown
       Downtime.find(@token, page: page)
     end
 
+    def get_metrics filters = {}
+      Updown::Call.metrics(@token, filters)
+    end
+
     def update(attributes={})
       Check.new Updown::Call.update_check(@token, attributes)
     end

data/lib/updown/cli.rb

@@ -33,7 +33,6 @@ module Updown
     desc 'open ID', 'Open the status page of a check'
     def open(token)
       configure_api_key
-      
       system "open https://updown.io/#{token}"
     end
 

data/lib/updown/version.rb

@@ -1,3 +1,3 @@
 module Updown
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: updown
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Aske Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,3 +143,4 @@ signing_key:
 specification_version: 4
 summary: updown.io API wrapper
 test_files: []
+has_rdoc: