uptrends 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a8350abcaf27e3eb580f7d57966bbdb33383c0
-  data.tar.gz: 657d3938ead33d2be4b33edcb7380e8361d3f938
+  metadata.gz: 746c1068cf00e9f2f419d3188c0a16f71834ff4e
+  data.tar.gz: eb43107d3d62e94e7489c0e976943cbd4293c367
 SHA512:
-  metadata.gz: 7d4e7c9662118f8a2028e72f8798ddecb0ec6fbbb728e48fb369af38cee7f08126e6919b9eaf68943a6be086fc1b4a875e8642b824f48d3a19979e818793c52e
-  data.tar.gz: b8518d4d9d8765cd5fdcb1f5b69ed71e58316b34e478fb8f681b72316013bd597a021fe937850c83898fbb2427525d5991bc9b970dd3d8c3229b0daeaac6d8ee
+  metadata.gz: 3bbf3f9381879d87824d8f23db448193fa622bc313c4989e9cc70c24881a760aa0448c63df0413203ebb4868195a4327100fbf3296b0ecfa554086072d638d98
+  data.tar.gz: bd898163b685d2f0b6422d42e96540aa56371839a48c146c63fd950d4aa5b815c948b3089c080f8c70cda1d77bfad760aa08bad5d417ae459a5e309d406ae0b6

data/README.md

@@ -22,9 +22,9 @@ Or install it yourself as:
 
 First initialize an instance of the API Client and then we play with it:
 
-    require 'uptrends/api_client'
-    u = Uptrends::ApiClient.new(username: 'my@email.com', password: 'MyP@sswo0rd')
-    #  => #<Uptrends::ApiClient:0x00000101309e48 @username="my@email.com">
+    require 'uptrends'
+    u = Uptrends::Client.new(username: 'my@email.com', password: 'MyP@sswo0rd')
+    #  => #<Uptrends::Client:0x00000101309e48 @username="my@email.com">
 
 Query your account for all probes:
 

data/examples/add_new_probes.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+require 'uptrends/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 = Uptrends::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 Uptrends::ApiError => e
+    puts e.message
+  end
+end
+

data/examples/add_probes_to_probe_group.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
-require 'uptrends/api_client'
+require 'uptrends/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 = Uptrends::ApiClient.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+u = Uptrends::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

data/examples/update_all_probe_attributes.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
-require 'uptrends/api_client'
+require 'uptrends/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 = Uptrends::ApiClient.new(username: ENV['UPTRENDS_USERNAME'], password: ENV['UPTRENDS_PASSWORD'])
+u = Uptrends::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

data/lib/uptrends.rb

@@ -1,4 +1,5 @@
 require "uptrends/version"
+require "uptrends/client"
 
 module Uptrends
   # Your code goes here...

data/lib/uptrends/api_error.rb

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

data/lib/uptrends/client.rb

@@ -0,0 +1,161 @@
+require "httparty"
+require "uptrends/probe"
+require "uptrends/probe_group"
+require "uptrends/utils"
+require "uptrends/api_error"
+
+module Uptrends
+  class Client
+    include HTTParty
+    format :json
+    base_uri('https://api.uptrends.com/v3')
+
+    attr_reader :username
+
+    def initialize(opts = {})
+      @username = opts[:username] ? opts[:username] : fail("You must specify the :username option")
+      password  = opts[:password] ? opts[:password] : fail("You must specify the :password option")
+
+      # This makes it so that every request uses basic auth
+      self.class.basic_auth(@username, password)
+      # This makes it so that every request uses ?format=json
+      self.class.default_params({format: 'json'})
+      # This makes it so that every request uses ?format=json
+      self.class.headers({'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+
+    def probes(opts = {})
+      if opts[:refresh]
+        @probes = get_probes
+      else
+        @probes ||= get_probes
+      end
+    end
+
+    def probe_groups
+      @probe_groups ||= get_probe_groups
+    end
+
+    def get_probe_group_members(opts = {})
+      group = opts[:group]
+      fail("You must pass a probe group using group: option.") unless Uptrends::ProbeGroup === group
+      group_guid = opts[:group].guid ? opts[:group].guid : fail("The probe group you passed does not have a guid.")
+
+      res = self.class.get("/probegroups/#{group_guid}/members")
+      parsed_response = raise_or_return(res)
+      probe_group_members = parsed_response.inject([]) do |memo, x|
+        memo << Uptrends::Probe.new(x)
+        memo
+      end
+    end
+
+    def add_probe(opts = {})
+      probe = Uptrends::Probe.new(opts)
+      res  = self.class.post("/probes", body: Uptrends::Utils.gen_request_body(probe))
+      parsed_response = raise_or_return(res)
+      new_probe = Uptrends::Probe.new(parsed_response)
+
+      probes << new_probe
+
+      new_probe
+    end
+
+    def add_probe_to_group(opts = {})
+      probe = opts[:probe]
+      group = opts[:group]
+
+      fail("You must pass a probe and probe group using probe: and group: opts.") unless Uptrends::Probe === probe && Uptrends::ProbeGroup === group
+
+      probe_guid = opts[:probe].guid ? opts[:probe].guid : fail("The probe you passed does not have a guid.")
+      group_guid = opts[:group].guid ? opts[:group].guid : fail("The probe group you passed does not have a guid.")
+
+
+      post_body = JSON.dump({"ProbeGuid" => probe_guid})
+      res = self.class.post("/probegroups/#{group_guid}/members", body: post_body)
+      raise_or_return(res)
+    end
+
+    def update_probe(probe)
+      res = self.class.put("/probes/#{probe.guid}", body: Uptrends::Utils.gen_request_body(probe))
+      raise_or_return(res)
+    end
+
+    def delete_probe(probe)
+      res = self.class.delete("/probes/#{probe.guid}")
+      raise_or_return(res)
+
+      probes.delete_if { |x| x.guid == probe.guid }
+    end
+
+    def create_http_probe(opts = {})
+      name            = opts[:name]            ? opts[:name]            : fail("You must provide a name!")
+      url             = opts[:url]             ? opts[:url]             : fail("You must provide a URL!")
+      check_frequency = opts[:check_frequency] ? opts[:check_frequency] : 15
+      match_pattern   = opts[:match_pattern]
+
+      probe     = Uptrends::Probe.new(gen_new_probe_hash(name, url, check_frequency, match_pattern))
+      res  = self.class.post("/probes", body: Uptrends::Utils.gen_request_body(probe))
+      parsed_response = raise_or_return(res)
+      new_probe = Uptrends::Probe.new(parsed_response)
+
+      probes << new_probe
+
+      new_probe
+    end
+
+    private
+    def get_probes
+      get_all(Uptrends::Probe)
+    end
+
+    def get_probe_groups
+      get_all(Uptrends::ProbeGroup)
+    end
+
+    def get_all(type)
+      case type.new
+      when Uptrends::ProbeGroup
+        uri = '/probegroups'
+      when Uptrends::Probe
+        uri = '/probes'
+      else
+        fail("You passed an unknown type. Try Uptrends::Probe or Uptrends::ProbeGroup")
+      end
+
+      res = self.class.get(uri)
+
+      parsed_response = raise_or_return(res)
+      all = parsed_response.inject([]) do |memo, x|
+        memo << type.new(x)
+        memo
+      end
+    end
+
+    def gen_new_probe_hash(name, url, check_frequency = 15, match_pattern = nil)
+      base_hash = {"Name"=>"", "URL"=>"", "CheckFrequency"=>check_frequency, "IsActive"=>true, "GenerateAlert"=>true, "Notes"=>"", "PerformanceLimit1"=>60000, "PerformanceLimit2"=>60000, "ErrorOnLimit1"=>false, "ErrorOnLimit2"=>false, "MinBytes"=>0, "ErrorOnMinBytes"=>false, "Timeout"=>30000, "TcpConnectTimeout"=>10000, "MatchPattern"=>"", "DnsLookupMode"=>"Local", "UserAgent"=>"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;)", "UserName"=>"", "Password"=>"", "IsCompetitor"=>false, "Checkpoints"=>"", "HttpMethod"=>"Get", "PostData"=>""}
+
+      if url =~ %r{^https:}i
+        base_hash.merge!({"Name"=>name, "URL"=>url, "ProbeType"=>"Https", "Port"=>443})
+      elsif url =~ %r{^http:}i
+        base_hash.merge!({"Name"=>name, "URL"=>url, "ProbeType"=>"Http", "Port"=>80})
+      else
+        fail("The URL you provided didn't start with http or https!")
+      end
+
+      base_hash.merge!({"MatchPattern"=>match_pattern}) unless match_pattern.nil?
+
+      base_hash
+    end
+
+    def raise_or_return(result)
+      response_code = result.response.code.to_i
+      case response_code
+        when 200...300
+          result.parsed_response
+        else
+          raise Uptrends::ApiError.new(result.parsed_response)
+      end
+    end
+
+  end
+end

data/lib/uptrends/utils.rb

@@ -5,10 +5,10 @@ module Uptrends
   class Utils
     def self.gen_request_body(object)
       new_hash = object.original_hash.inject({}) do |memo,(k,v)|
-        if k == 'Guid'
+        if k.to_s.underscore == 'guid'
           memo
         else
-          memo[k] = object.send(k.underscore)
+          memo[k.to_s.camelize] = object.send(k.to_s.underscore)
           memo
         end
       end
@@ -30,12 +30,14 @@ module Uptrends
       attributes = []
       object.original_hash.each_pair do |k,v|
 
-        k = k.underscore
+        k = k.to_s.underscore
         case k
         when "guid"
+          # setup attr_reader for guid and set it's value.
           object.class.send(:attr_reader, k)
           object.instance_variable_set("@#{k}", v)
         else
+          # setup a attr_accessor for all other attributes
           object.class.send(:attr_accessor, k)
           object.send("#{k}=", v)
         end

data/lib/uptrends/version.rb

@@ -1,3 +1,3 @@
 module Uptrends
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 require_relative '../lib/uptrends'
-require_relative '../lib/uptrends/api_client'
+require_relative '../lib/uptrends/client'
 require_relative '../lib/uptrends/probe'
 require_relative '../lib/uptrends/probe_group'
 require_relative '../lib/uptrends/utils'

data/spec/uptrends/{api_client_spec.rb → client_spec.rb}

@@ -1,6 +1,6 @@
 require_relative '../spec_helper'
 
-describe Uptrends::ApiClient do
+describe Uptrends::Client do
   let(:username) { ENV['UPTRENDS_USERNAME'] }
   let(:password) { ENV['UPTRENDS_PASSWORD'] }
 
@@ -14,36 +14,36 @@ describe Uptrends::ApiClient do
     end
   end
 
-  it "must be an instance of Uptrends::ApiClient" do
-    Uptrends::ApiClient.new(username: username, password: password).must_be_instance_of Uptrends::ApiClient
+  it "must be an instance of Uptrends::Client" do
+    Uptrends::Client.new(username: username, password: password).must_be_instance_of Uptrends::Client
   end
 
   describe "Initializing with a username and password is required" do
     it "should raise RuntimeError when username is not provided." do
-      proc { Uptrends::ApiClient.new(password: password) }.must_raise RuntimeError
+      proc { Uptrends::Client.new(password: password) }.must_raise RuntimeError
     end
 
     it "should raise excepetion when password is not provided." do
-      proc { Uptrends::ApiClient.new(username: username) }.must_raise RuntimeError
+      proc { Uptrends::Client.new(username: username) }.must_raise RuntimeError
     end
   end
 
   describe "default attributes" do
     it "must include httparty methods" do
-      Uptrends::ApiClient.must_include HTTParty
+      Uptrends::Client.must_include HTTParty
     end
 
     it "must have the base url set to the Uptrends API endpoint" do
-      Uptrends::ApiClient.base_uri.must_equal 'https://api.uptrends.com/v3'
+      Uptrends::Client.base_uri.must_equal 'https://api.uptrends.com/v3'
     end
 
     it "must have the format set to json" do
-      Uptrends::ApiClient.format.must_equal :json
+      Uptrends::Client.format.must_equal :json
     end
   end
 
   describe "When initializing a new Uptrends::Client with a username and password" do
-    let(:uac) { Uptrends::ApiClient.new(username: username, password: password) }
+    let(:uac) { Uptrends::Client.new(username: username, password: password) }
 
     it "auth[:username] should match the username provided" do
       uac.class.default_options[:basic_auth][:username].must_equal username
@@ -63,7 +63,7 @@ describe Uptrends::ApiClient do
   end
 
   describe "querying Uptrends" do
-    let(:uac) { Uptrends::ApiClient.new(username: username, password: password) }
+    let(:uac) { Uptrends::Client.new(username: username, password: password) }
 
     describe "GET Probes" do
       before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrends
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jason Barnett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -53,17 +53,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/add_new_probes.rb
 - examples/add_probes_to_probe_group.rb
 - examples/update_all_probe_attributes.rb
 - lib/uptrends.rb
-- lib/uptrends/api_client.rb
+- lib/uptrends/api_error.rb
+- lib/uptrends/client.rb
 - lib/uptrends/probe.rb
 - lib/uptrends/probe_group.rb
 - lib/uptrends/utils.rb
 - lib/uptrends/version.rb
 - spec/fixtures/vcr_cassettes/GET_Probes.yml
 - spec/spec_helper.rb
-- spec/uptrends/api_client_spec.rb
+- spec/uptrends/client_spec.rb
 - spec/uptrends/probe_group_spec.rb
 - spec/uptrends/probe_spec.rb
 - uptrends.gemspec
@@ -87,13 +89,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper around the Uptrends API, http://www.uptrends.com/
 test_files:
 - spec/fixtures/vcr_cassettes/GET_Probes.yml
 - spec/spec_helper.rb
-- spec/uptrends/api_client_spec.rb
+- spec/uptrends/client_spec.rb
 - spec/uptrends/probe_group_spec.rb
 - spec/uptrends/probe_spec.rb

data/lib/uptrends/api_client.rb

@@ -1,130 +0,0 @@
-require "httparty"
-require "uptrends/probe"
-require "uptrends/probe_group"
-require "uptrends/utils"
-
-module Uptrends
-  class ApiClient
-    include HTTParty
-    format :json
-    base_uri('https://api.uptrends.com/v3')
-
-    attr_reader :username
-
-    def initialize(options = {})
-      @username = options[:username] ? options[:username] : fail("You must specify the :username option")
-      password  = options[:password] ? options[:password] : fail("You must specify the :password option")
-
-      # This makes it so that every request uses basic auth
-      self.class.basic_auth(@username, password)
-      # This makes it so that every request uses ?format=json
-      self.class.default_params({format: 'json'})
-      # This makes it so that every request uses ?format=json
-      self.class.headers({'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-    end
-
-    def probes
-      @probes ||= get_probes
-    end
-
-    def probe_groups
-      @probe_groups ||= get_probe_groups
-    end
-
-    private
-    def get_probes
-      get_all(Uptrends::Probe)
-    end
-
-    def get_probe_groups
-      get_all(Uptrends::ProbeGroup)
-    end
-
-    def get_all(type)
-      case type.new
-      when Uptrends::ProbeGroup
-        uri = '/probegroups'
-      when Uptrends::Probe
-        uri = '/probes'
-      else
-        fail("You passed an unknown type. Try Uptrends::Probe or Uptrends::ProbeGroup")
-      end
-
-      parsed_response = self.class.get(uri).parsed_response
-
-      all = parsed_response.inject([]) do |memo, x|
-        memo << type.new(x)
-        memo
-      end
-    end
-
-    public
-    def get_probe_group_members(options = {})
-      group = options[:group]
-      fail("You must pass a probe group using group: option.") unless Uptrends::ProbeGroup === group
-      group_guid = options[:group].guid ? options[:group].guid : fail("The probe group you passed does not have a guid.")
-
-      parsed_response = self.class.get("/probegroups/#{group_guid}/members").parsed_response
-      probe_group_members = parsed_response.inject([]) do |memo, x|
-        memo << Uptrends::Probe.new(x)
-        memo
-      end
-    end
-
-    def add_probe_to_group(options = {})
-      probe = options[:probe]
-      group = options[:group]
-
-      fail("You must pass a probe and probe group using probe: and group: options.") unless Uptrends::Probe === probe && Uptrends::ProbeGroup === group
-
-      probe_guid = options[:probe].guid ? options[:probe].guid : fail("The probe you passed does not have a guid.")
-      group_guid = options[:group].guid ? options[:group].guid : fail("The probe group you passed does not have a guid.")
-
-
-      post_body = JSON.dump({"ProbeGuid" => probe_guid})
-      self.class.post("/probegroups/#{group_guid}/members", body: post_body)
-    end
-
-    def update_probe(probe)
-      self.class.put("/probes/#{probe.guid}", body: Uptrends::Utils.gen_request_body(probe))
-    end
-
-    def delete_probe(probe)
-      self.class.delete("/probes/#{probe.guid}")
-
-      @probes ||= get_probes
-      @probes.delete_if { |x| x.guid == probe.guid }
-    end
-
-    def create_http_probe(options = {})
-      name          = options[:name]          ? options[:name] : fail("You must provide a name!")
-      url           = options[:url]           ? options[:url]  : fail("You must provide a URL!")
-      match_pattern = options[:match_pattern]
-
-      probe     = Uptrends::Probe.new(gen_new_probe_hash(name, url, match_pattern))
-      response  = self.class.post("/probes", body: Uptrends::Utils.gen_request_body(probe))
-      new_probe = Uptrends::Probe.new(response.parsed_response)
-
-      @probes ||= get_probes
-      @probes << new_probe
-    end
-
-    private
-    def gen_new_probe_hash(name, url, match_pattern = nil)
-      base_hash = {"Name"=>"", "URL"=>"", "CheckFrequency"=>5, "IsActive"=>true, "GenerateAlert"=>true, "Notes"=>"", "PerformanceLimit1"=>60000, "PerformanceLimit2"=>60000, "ErrorOnLimit1"=>false, "ErrorOnLimit2"=>false, "MinBytes"=>0, "ErrorOnMinBytes"=>false, "Timeout"=>30000, "TcpConnectTimeout"=>10000, "MatchPattern"=>"", "DnsLookupMode"=>"Local", "UserAgent"=>"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;)", "UserName"=>"", "Password"=>"", "IsCompetitor"=>false, "Checkpoints"=>"", "HttpMethod"=>"Get", "PostData"=>""}
-
-      if url =~ %r{^https:}i
-        base_hash.merge!({"Name"=>name, "URL"=>url, "ProbeType"=>"Https", "Port"=>443})
-      elsif url =~ %r{^http:}i
-        base_hash.merge!({"Name"=>name, "URL"=>url, "ProbeType"=>"Http", "Port"=>80})
-      else
-        fail("The URL you provided didn't start with http or https!")
-      end
-
-      base_hash.merge!({"MatchPattern"=>match_pattern}) unless match_pattern.nil?
-
-      base_hash
-    end
-
-  end
-end