uptrends_extended 0.7.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjM1MTE1NWJkOGE5ZmI3N2U4N2FjNzFjNWUzYmMyNjFlMjQzZTQ4Nw==
+  data.tar.gz: !binary |-
+    ZDE4ZmZiNGEwMjMxMTU4NDdhNmE0ZDBiOTEzYjAzMjI3NDY3MjBlMA==
+SHA512:
+  metadata.gz: !binary |-
+    OTZmNjZkMGJmZTIxNDAxN2E5NzM3NDJjZDk3OGI2NzU3YTQ3ZTA0YzBiZDQy
+    YjY0ZDM4ZWY2MGQxMTA5MTIxZWM0YjgyNTI2YmY4YWE3YzMwOGFhNjQ5Nzhi
+    NGFjMThmYzkwYWRhZWY0MTIyNzJmZGFhZWI0NGNiMmYyNjRlNWY=
+  data.tar.gz: !binary |-
+    ZTBiYTgwYjk0NGY1NmZhZGU0NzIzYjgzNThhN2IwNmE0NWU1ZDJjMzczZDEw
+    YjFlZjhhN2M2NTJhZWQ0ODNmZjg4YzJkZDU1YmUxMWRmNDg1YzBhMzdiNzUx
+    Yjg0OTc0ZTIyNjg1ODVmNDZlN2I5MzEwZWUyZDkwYWIzYjAyNjM=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.idea
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.1.0
+  - 1.9.3
+
+env: UPTRENDS_USERNAME=my@username.com UPTRENDS_PASSWORD=password
+
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# UptrendsExtended Gem Changelog
+
+## 0.7.0
+- Added the statistics part, so you are able to get statistics about probes and probegroups
+- Minor syntax fixes for rails 3 and up
+
+## 0.6.0
+- Completely redesigned the UptrendsExtended::Client class to make it more idiomatic.
+- Completely redesigned the UptrendsExtended::Base class to make it more idiomatic.
+- Added #create!, #update! and #delete! methods to UptrendsExtended::Base
+- Added #enable, #disable, #enable_alerts and #disable_alerts methods to UptrendsExtended::Probe
+- Added #add_probe, #remove_probe and #members methods to UptrendsExtended::ProbeGroup
+- Removed UptrendsExtended::Utils class
+
+## 0.5.0
+- Added UptrendsExtended::Monitor class.
+- Added UptrendsExtended::Client#monitors method to fetch all monitors.
+

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uptrends_extended.gemspec
+gemspec
+
+gem 'httparty',      '~> 0.13'
+gem 'activesupport', '~> 03.2.13'
+
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+  gem 'rake'
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2015 Jason Barnett
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Uptrends RESTful API Client
+
+[![Code Climate](https://codeclimate.com/github/microting/uptrends-gem/badges/gpa.svg)](https://codeclimate.com/github/microting/uptrends-gem) [![Test Coverage](https://codeclimate.com/github/microting/uptrends-gem/badges/coverage.svg)](https://codeclimate.com/github/microting/uptrends-gem/coverage) [![Build Status](https://travis-ci.org/microting/uptrends-gem.svg)](https://travis-ci.org/microting/uptrends-gem) [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/microting/uptrends-gem/blob/master/LICENSE.txt)
+
+This is a ruby wrapper around the [Uptrends API][2]. Uptrends is a monitoring service that let's you monitor Web pages, Web services, Mail servers, Database servers, DNS, SSL certificates, FTP and more.
+
+NOTE: This is a 3rd party gem and not an official product from Uptrends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uptrends_extended'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uptrends_extended
+
+## Usage
+
+    require 'uptrends_extended'
+    u = UptrendsExtended::Client.new(username: 'my@email.com', password: 'MyP@sswo0rd')   #=> #<UptrendsExtended::Client>
+
+    probes = u.probes                     #=> [#<UptrendsExtended::Probe>, #<UptrendsExtended::Probe>, ...]
+    p = probes.first                      #=> #<UptrendsExtended::Probe>
+    p.attributes                          #=> [:guid, :name, :url, :port, :check_frequency, :probe_type, :is_active, :generate_alert, :notes, :performance_limit1, :performance_limit2, :error_on_limit1, :error_on_limit2, :min_bytes, :error_on_min_bytes, :timeout, :tcp_connect_timeout, :match_pattern, :dns_lookup_mode, :user_agent, :user_name, :password, :is_competitor, :checkpoints, :http_method, :post_data]
+    p.guid                                #=> "7ef43a1b255949f5a052444348971690"
+    p.name                                #=> "My Probe's Name"
+    p.statistics('2015/01/01', '2015/12/31', 'Year') #=> [{"Dimension"=>"2015", "Alerts"=>0, "SLAPercentage"=>99.8, "SLATotalTime"=>2, "SLAOperatorResponseTime"=>15, "AvgOperatorResponseTime"=>0, "PercentageOK"=>99.82507, "PercentageError"=>0.1749256, "PercentageUnknown"=>0, "PercentageUptime"=>99.82507, "TotalChecks"=>3168, "Errors"=>5, "UnconfirmedErrors"=>12, "SecondsOK"=>1893489, "SecondsError"=>3318, "SecondsUnknown"=>0, "AverageTotalTime"=>1.229745, "AverageResolveTime"=>0.1484861, "AverageConnectionTime"=>0.1247686, "AverageDownloadTime"=>0.9560824, "AverageTotalBytes"=>6961}]
+    p.uptime_this_year                    #=> {:sla=>99.8, :uptime=>99.82507}
+    p.uptime_last_12_month                #=> {:sla=>99.8, :uptime=>99.82158}
+
+    probe_groups = u.probe_groups         #=> [#<UptrendsExtended::ProbeGroup>, #<UptrendsExtended::ProbeGroup>, ... ]
+    pg = probe_groups.first               #=> #<UptrendsExtended::ProbeGroup>
+    pg.attributes                         #=> [:guid, :name, :is_all, :is_client_probe_group]
+    pg.guid                               #=> "c8d6a0f704494c37823850f3d4fd4273"
+    pg.name                               #=> "All probes"
+
+    # Let's change the name of the probe:
+    p.name = "My Probe's NEW name"        #=> "My Probe's NEW name"
+    p.update!                             #=> nil
+
+    # Let's add our probe to our probe group
+    pg.add_probe(p)                       #=> [#<UptrendsExtended::ProbeGroup>, #<UptrendsExtended::Probe>]
+
+## Contributing
+
+1. Fork it ( https://github.com/microting/uptrends-gem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+[1]: https://uptrends.com/
+[2]: http://www.uptrends.com/en/support/api

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/uptrends_extended/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/examples/add_new_probes.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+require 'uptrends_extended/client'
+require 'uri'
+require 'rack'
+
+def parse_uri_for_db(url)
+  begin
+    uri = URI(url)
+    Rack::Utils.parse_query(uri.query)['dbname'].downcase
+  rescue URI::InvalidURIError
+    return nil
+  end
+end
+
+def parse_uri(url)
+  begin
+    uri = URI(url)
+    "#{uri.scheme}://#{uri.host}".downcase
+  rescue URI::InvalidURIError
+    return nil
+  end
+end
+
+(puts "You must set both the \"UPTRENDS_USERNAME\" and \"UPTRENDS_PASSWORD\" environment variables, exiting..."; exit 1;) unless ENV['UPTRENDS_USERNAME'] && ENV['UPTRENDS_PASSWORD']
+
+u = UptrendsExtended::Client.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+
+filename  = ARGV.first
+site_urls = File.open(filename)
+site_urls = site_urls.readlines.map { |x| x.delete("\n") }.compact
+
+# Build array of URLs to possibly add to Uptrends
+uri_array = site_urls.map do |url|
+  uri = parse_uri(url)
+  db  = parse_uri_for_db(url)
+  next unless uri && db
+  [uri, db]
+end.compact.uniq
+
+# Build array of Uptrends Probe URLs that already exist
+probe_uri_array = u.probes.map do |x|
+  next unless x.probe_type =~ /Https?/
+  parse_uri(x.url)
+end.compact
+
+uri_array.each do |uri|
+  url = uri[0]
+  db  = uri[1]
+
+  # If URL contains certain things we don't want to add it Uptrends
+  next if url =~ /\.xxx/i         ||
+          url =~ /backup/i        ||
+          url =~ /clusterbogota/i ||
+          url =~ /archive/i       ||
+          url =~ /thebigawards/i  ||
+          url =~ /staging/i       ||
+          url =~ /qa(languages)?[0-9gaspb]+(prod)?\./i
+  # If the URL already exists at Uptrends we don't want to add it again!
+  next if probe_uri_array.include?(url)
+
+  url = "#{uri[0]}/User/Login"
+  db  = uri[1]
+
+  puts "Adding a \"#{url}\" probe"
+  begin
+    new_probe = u.create_http_probe(name: db, url: url, match_pattern: 'j_username')
+  rescue UptrendsExtended::ApiError => e
+    puts e.message
+  end
+end
+

data/examples/add_probes_to_probe_group.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'uptrends_extended'
+
+(puts "You must set both the \"UPTRENDS_USERNAME\" and \"UPTRENDS_PASSWORD\" environment variables, exiting..."; exit 1;) unless ENV['UPTRENDS_USERNAME'] && ENV['UPTRENDS_PASSWORD']
+
+u = UptrendsExtended::Client.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+
+# select our probe group by name
+linux_probe_group = u.probe_groups.select { |x| x.name =~ /Linux/}.first
+
+# grab the current group members
+linux_group_members = u.get_probe_group_members(group: linux_probe_group)
+
+# build an array of current probe group members guid
+member_guids = linux_group_members.inject([]) do |memo, x|
+  memo << x.guid
+  memo
+end
+
+# add any missing probes to our probe group
+u.probes.each do |x|
+  next if member_guids.include?(x.guid)
+
+  puts "Adding \"#{x.name}\" to the \"#{linux_probe_group.name}\" group now... "
+  u.add_probe_to_group(probe: x, group: linux_probe_group)
+end

data/examples/get_checkpoint_ips.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "uptrends_extended"
+require "ipaddr"
+
+(puts "You must set both the \"UPTRENDS_USERNAME\" and \"UPTRENDS_PASSWORD\" environment variables, exiting..."; exit 1;) unless ENV['UPTRENDS_USERNAME'] && ENV['UPTRENDS_PASSWORD']
+
+u = UptrendsExtended::Client.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+checkpoint_ips = u.checkpoints.inject([]) { |memo,x| memo << x.ip_address; memo }.sort_by { |x| IPAddr.new(x) }
+
+checkpoint_ips.each do |ip|
+  puts "allow #{ip};"
+end

data/examples/update_all_probe_attributes.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'uptrends_extended/client'
+
+(puts "You must set both the \"UPTRENDS_USERNAME\" and \"UPTRENDS_PASSWORD\" environment variables, exiting..."; exit 1;) unless ENV['UPTRENDS_USERNAME'] && ENV['UPTRENDS_PASSWORD']
+
+u = UptrendsExtended::Client.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+
+u.probes.each do |x|
+  next if x.dns_lookup_mode == 'Local' && x.timeout == 20000 && x.tcp_connect_timeout == 5000
+
+  x.dns_lookup_mode = 'Local'
+  x.timeout = 20000
+  x.tcp_connect_timeout = 5000
+
+  puts "Updating the \"#{x.name}\" probe now... "
+  u.update_probe(x)
+end

data/lib/uptrends_extended.rb

@@ -0,0 +1,3 @@
+require 'uptrends_extended/version'
+require 'uptrends_extended/client'
+

data/lib/uptrends_extended/api_error.rb

@@ -0,0 +1,4 @@
+module UptrendsExtended
+  class ApiError < ::StandardError
+  end
+end

data/lib/uptrends_extended/base.rb

@@ -0,0 +1,121 @@
+require 'uptrends_extended/api_error'
+require 'json'
+require 'active_support/inflector'
+
+module UptrendsExtended
+  class Base
+
+    attr_reader :attributes
+
+    def initialize(client, response, attributes = {})
+      @client     = client
+      @attributes = attributes
+      gen_and_set_accessors
+    end
+
+    def create!
+      response = @client.class.post(api_url, body: gen_request_body)
+      self.class.parse(@client, response)
+    end
+
+    def update!
+      response = @client.class.put("#{api_url}/#{@guid}", body: gen_request_body)
+      self.class.check_error!(response)
+    end
+
+    def delete!
+      response = @client.class.delete("#{api_url}/#{@guid}")
+      self.class.check_error!(response)
+    end
+
+    def self.check_error!(response)
+      response_code = response.response.code.to_i
+      case response_code
+        when 200...300
+          response.parsed_response
+        else
+          raise UptrendsExtended::ApiError.new(response.parsed_response)
+      end
+    end
+
+    # @param [yyyy/mm/dd] start_of_period
+    # @param [yyyy/mm/dd] end_of_period
+    # @param [Day, Week, Month, Year, ProbeGroup, Probe, Checkpoint, ErrorCode, ErrorLevel] dimension
+    def statistics(start_of_period, end_of_period, dimension)
+      response = @client.class.get("#{api_url}/#{@guid}/statistics?Start=#{start_of_period}&End=#{end_of_period}&Dimension=#{dimension}", body: gen_request_body)
+      self.class.check_error!(response)
+    end
+
+    def uptime_this_year
+      stats = statistics("#{Time.now.year}/01/01", "#{Time.now.year}/12/31", 'Year')
+      {sla: stats[0]['SLAPercentage'], uptime: stats[0]['PercentageUptime']}
+    end
+
+    def uptime_last_12_months
+      start_period = Time.now - 12.months
+      stats = statistics(start_period.strftime('%Y/%m/%d'), Time.now.strftime('%Y/%m/%d'), 'Year')
+      {sla: stats[0]['SLAPercentage'], uptime: stats[0]['PercentageUptime']}
+    end
+
+    def self.parse(client, response)
+      check_error!(response)
+      parsed_response = response.parsed_response
+      if Array === parsed_response
+        parsed_response.map do |item|
+          new(client, response, item)
+        end
+      else
+        new(client, response, parsed_response)
+      end
+    end
+
+    def to_s
+      string = []
+      attributes.each do |attr|
+        string << "#{attr}: #{self.send(attr)}"
+      end
+
+      "#{string.join("\n")}"
+    end
+
+    private
+
+    # This method sets up all of our attr_accessor so we can easily edit probe attributes
+    def gen_and_set_accessors
+      attributes = []
+      self.attributes.each_pair do |k,v|
+
+        k = k.to_s.underscore
+        case k
+        when 'guid'
+          # setup attr_reader for guid and set it's value.
+          self.class.send(:attr_reader, k)
+          self.instance_variable_set("@#{k}", v)
+        else
+          # setup a attr_accessor for all other attributes
+          self.class.send(:attr_accessor, k)
+          self.send("#{k}=", v)
+        end
+        attributes << k.to_sym
+
+      end
+
+      @attributes = attributes
+    end
+
+    def gen_request_body
+      new_hash = @attributes.inject({}) do |memo,(k,v)|
+        if k.to_s.underscore == 'guid'
+          memo
+        else
+          memo[k.to_s.camelize] = self.send(k.to_s.underscore)
+          memo
+        end
+      end
+
+      request_body = JSON.dump(new_hash)
+    end
+
+  end
+end
+