ihealth 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91693c879dadb353501ae445f7372a2e8800a786
+  data.tar.gz: 4ae341cd07f176f9f42979051943b210bdc14210
+SHA512:
+  metadata.gz: 004e927687b3848ff4a89550e910e1d42787427ca71f1ce9d1fa80cdec05f3038c6d7d9a26047318f25aace88123ca1160ed92adebb30be534562d04ef47b88b
+  data.tar.gz: 0f025cf2579f45aa486f68c79407622f1d2c3001ef9d1190a10296f1f3dec2daf41bbd0db5d4ec4802c0047847e0fddf0af4aa9834c230dafefbd868905b4edc

data/lib/ihealth.rb

@@ -0,0 +1,250 @@
+# This gem abstracts F5s iHealth API and allows.
+# This gem will allow you to do the following:
+#  * Authenticate
+#  * Upload a qkview
+#  * Get list of IDs of qkviews already uploaded
+#  * Get meta data about a particular ID already uploaded
+#  * Get the full heuristic report for an ID already uploaded
+#
+# Author:: Dave B. Greene (omniplex@omniplex.net)
+# Copyright:: Copyright (c) 2012 Dave Greene
+# License:: GPL V3
+ 
+
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+# This class provides the interface to F5s iHealth API system
+# and requires that you have an active account with F5.
+class Ihealth
+
+  # Sets the default "User Agent" that will be passed to identify the application
+  # Please Change the User Agent to be descriptive for your organization.
+  USER_AGENT = "Ruby iHealth Gem/2.3.0"
+
+  # Creates the initial connection by performaing authentication
+  def initialize username, password, proxyserver = nil, proxyport = nil, proxyuser = nil, proxypass = nil
+    @username = username
+    @password = password
+    @proxyserver = proxyserver
+    @proxyport = proxyport
+    @proxyuser = proxyuser
+    @proxypass = proxypass
+    @authenticated = false
+    @IHEALTHBASE= "https://ihealth-api.f5.com/qkview-analyzer/api/"
+    
+    # Try and authenticate
+    authenticate
+  end
+  
+  # Uploads a file to iHealth for heuristic processing
+  def upload filepath
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews?retain=true")
+    headers = {'User Agent' => USER_AGENT, 'Transfer-Encoding' => 'chunked', 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    ihealthrequest = Net::HTTP::Post.new(url.path + "?" + url.query, headers)
+    ihealthrequest.content_type = 'application/gzip'
+    ihealthrequest.set_form_data('visible_in_gui' => 'true')
+    ihealthrequest.body_stream = File.open(filepath, 'rb')
+    response = ihealthclient.request(ihealthrequest)
+    response.code == "303" ? (return response['location'][/[0-9]*$/,0]) : (return nil)
+  end
+
+  # Gets a list of IDs that are stored in the iHealth system after qkviews have been uploaded.
+  def get_list format = "json"
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews.#{format}")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    #ihealthclient = Net::HTTP.new(url.host, url.port)
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http| 
+      http.request(httprequest)
+    end
+    response.code != "200" ? (raise "We received #{response.code}") : (return t_ids = JSON.parse(response.body))
+  end
+  
+  # Gets meta data for a particular ID where a qkview has already been upladed to the iHealth system.
+  def get_meta qid, format = "json"
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews/#{qid}.#{format}")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    #ihealthclient = Net::HTTP.new(url.host, url.port)
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    response.code != "200" ? (return nil) : (return t_meta = JSON.parse(response.body))
+  end
+  
+  # Gets the diagnostic data for an ID where a qkview has already been uploaded to the iHealth system.
+  # Default output format is JSON.
+  def get_diagnostics qid, format = "json"
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews/#{qid}/diagnostics.#{format}?set=hit&audience=all")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    #ihealthclient = Net::HTTP.new(url.host, url.port)
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path + "?" + url.query, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    response.code != "200" ? (return nil) : (return t_diagnostic = JSON.parse(response.body))
+  end
+  
+  # Deletes a qkview from the system.
+  def delete qid
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews/#{qid}")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port, @proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Delete.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    return response.code
+  end
+
+  def delete_all
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port, @proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Delete.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    return response.code
+  end
+
+  # This method returns the list of available commands to execute against a given diagnostic
+  def get_command_list qid, format = "json"
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews/#{qid}/commands.#{format}")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    response.code != "200" ? (return nil) : (return t_commands = JSON.parse(response.body))
+  end
+
+  # Get the result from a single command
+  # Currently there is a bug in iHealth that only allows a single command to work.
+  def get_command_output qid, command, format = "json"
+    authenticate if !@authenticated
+    url = URI("#{@IHEALTHBASE}qkviews/#{qid}/commands/#{command}.#{format}")
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    response.code != "200" ? (return nil) : (return t_commands = JSON.parse(response.body))
+  end
+
+
+  # def get_commands_output qid, commands, format = "json"
+  #   authenticate if !@authenticated
+  #   url = URI("#{@IHEALTHBASE}qkviews/#{qid}/command.#{format}")
+  #   respone = make_request url
+  #   # headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+  #   # @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+  #   # ihealthclient.use_ssl = true
+  #   # ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  #   # httprequest = Net::HTTP::Get.new(url.path + "?" + url.query, headers)
+  #   # httprequest.content_type = 'application/xml'
+  #   # response = ihealthclient.start do |http|
+  #   #   http.request(httprequest)
+  #   # end
+  #   response.code != "200" ? (return nil) : (t_commands = JSON.parse(response.body))
+  #   return t_commands['qvCommandOutputList'] 
+  # end
+  
+  
+
+# no reason to call authenticate directly
+  private 
+  
+  # Performs authentication and saves the cookie information
+  def authenticate
+    # probably should abstract this out more.
+    url = URI('https://login.f5.com/resource/loginAction.jsp')
+    headers = {'User Agent' => USER_AGENT }
+    #ihealthclient = Net::HTTP.new(url.host, url.port)
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+      ihealthclient.use_ssl = true
+      ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      httprequest = Net::HTTP::Post.new(url.path, headers)
+      httprequest.set_form_data('userid' => @username, 'passwd' => @password)
+      httprequest.content_type = 'application/x-www-form-urlencoded'
+
+      response = ihealthclient.start do |http|
+        http.request(httprequest)
+      end
+
+    # All reponse codes seem to be redirects. Either back to the login page or the account page
+    # so we check for the account page.
+    if (response['location'] == 'https://login.f5.com/myaccount/index.jsp')
+      @authenticated = true
+      all_cookies = response.get_fields('set-cookie')
+      cookies_array = Array.new
+        all_cookies.each { | cookie |
+        cookies_array.push(cookie.split('; ')[0])
+        }
+      @cookies = cookies_array.join('; ')
+    end
+  end
+  
+  # TODO: Create method to handle web requests and return data so everything isn't repeated
+  # Below works if a GET request. Need to modify for all types.
+  def make_request url
+    authenticate if !@authenticated
+
+    headers = {'User Agent' => USER_AGENT, 'Cookie' => @cookies }
+    @proxyserver.nil? ? (ihealthclient = Net::HTTP::new(url.host, url.port)) : (ihealthclient = Net::HTTP::new(url.host, url.port,@proxyserver, @proxyport, @proxyuser, @proxypass))
+    ihealthclient.use_ssl = true
+    ihealthclient.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    httprequest = Net::HTTP::Get.new(url.path + "?" + url.query, headers)
+    httprequest.content_type = 'application/xml'
+    response = ihealthclient.start do |http|
+      http.request(httprequest)
+    end
+    return response
+    
+  end
+
+
+end
+
+
+

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: ihealth
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Dave B. Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies: []
+description: An abstraction layer to provide functionality to F5's iHealth reporting
+  interface
+email: omniplex@omniplex.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ihealth.rb
+homepage: http://rubygems.org/gems/ihealth
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- A valid support account with F5
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Interface to F5s iHealth API
+test_files: []