framework_gem 0.1.0

data/lib/lib/data_services/splunk_data_reader.rb

@@ -0,0 +1,77 @@
+# :host => "chrcnc-hnav-splunksearchhead-01.os.vap.rr.com",
+# chost = '71.74.188.137'
+# :username => "figaro",
+# :password => "figaro"
+
+# Install splunk with the file splunkforwarder.zip
+=begin
+# Update the configuration file: .../splunkforwarder/etc/system/local/inputs.conf with the following entries:
+
+I[default]
+host = joesTesting
+
+[monitor://xc]
+sourcetype =weblogger
+index=figaro
+ignoreOlderThan = 7d
+
+=end
+
+# Use the following command to validate connection to the splunk server
+#    curl -k -u <username>:<password> https://chrcnc-hnav-splunksearchhead-01.os.vap.rr.com:8089/services/apps/local
+
+
+# Use the following command to write data to the splunk forwarder
+# echo "Hello figaro" >> /Users/jdavison/splunkinput/joe.log
+
+# Use the following commands to install the gem to read content on the splunk server from ruby:
+# git clone https://github.com/splunk/splunk-sdk-ruby.git
+# sudo gem install splunk-sdk-ruby
+
+require 'splunk-sdk-ruby'
+class SplunkDataReader
+
+  @service = ""
+  def initialize
+    config = {:scheme => :https,
+              :host => "chrcnc-hnav-splunksearchhead-01.os.vap.rr.com",
+              :port => 8089,
+              :username => "figaro",
+              :password => "figaro"
+    }
+
+    @service = Splunk::connect(config)
+  end
+
+  def read_from_splunk
+    job = @service.create_search("search index=figaro",
+                                 :earliest_time => "-30d",
+                                 :latest_time => "now")
+
+    while !job.is_ready?()
+      sleep(0.1)
+    end
+
+    while !job.is_done?()
+      sleep(0.1)
+    end
+
+    stream = job.results(:count => 1, :offset => 0)
+# Or: stream = job.events(:count => 3, :offset => 0)
+    results = Splunk::ResultsReader.new(stream)
+    results.each do |result|
+      puts result["_raw"]
+    end
+  end
+
+end
+
+# s = SplunkDataReader.new
+# s.read_from_splunk
+# s.read_from_splunk
+
+
+
+
+
+

data/lib/lib/element/element.rb

@@ -0,0 +1,79 @@
+# The Element class is a wrapper for an element attribute hash which exposes the hash and also allows access to the
+# values using the keys as if they were methods.
+
+class Element
+
+  # Public: Initializes an element. NOT FOR USE IN TESTS.
+  #
+  # Returns nothing.
+  def initialize(hash)
+    @hash = rubify(hash)
+  end
+
+  # Public: Gets element attribute.
+  #
+  # key - Symbol attribute to retrieve.
+  #
+  # Returns Object value of specified attribute.
+  def [](key)
+    key = key.to_s
+    raise %Q(No attribute "#{key}"!) unless @hash.keys.include?(key)
+    @hash[key]
+  end
+
+  # Public: Sets element attribute.
+  #
+  # key   - Symbol attribute to set.
+  # value - Object value to set.
+  #
+  # Returns nothing.
+  def []=(key, value)
+    key = key.to_s
+    raise %Q(No attribute "#{key}"!) unless @hash.keys.include?(key)
+    @hash[key] = value
+  end
+
+  # Public: Gets/sets element attribute via accessor. NOT FOR USE IN TESTS.
+  #
+  # m    - Symbol or String name of attribute.
+  # args - Splat Array of Object arguments. When used like a setter, assigns the first item as the value.
+  # _    - Block unused.
+  #
+  # Returns nothing.
+  def method_missing(m, *args, &_)
+    m = m.to_s
+    m_key = m.sub(/=$/, '')
+    raise %Q(No attribute "#{m_key}"!) unless @hash.keys.include?(m_key)
+    if m_key.eql?(m)
+      @hash[m_key]
+    else
+      @hash[m_key] = args.first
+    end
+  end
+
+  # Public: Checks if the element contains the specified element or area.
+  #
+  # element - Element or area Hash with keys :x, :y, :width, :height.
+  #
+  # Returns true if the element contains the specified element or area.
+  def contains?(element)
+    element[:x] >= self[:x] && (element[:x] + element[:width]) <= (self[:x] + self[:width]) &&
+        element[:y] >= self[:y] && (element[:y] + element[:height]) <= (self[:y] + self[:height])
+  end
+
+  private
+
+  # Internal: Converts TMC server JSON hash to Ruby format, i.e. 'isOnScreen' becomes 'is_on_screen' etc.
+  #
+  # Returns nothing.
+  def rubify(json_hash)
+    ruby_hash = {}
+    json_hash.each do |k,v|
+      # Convert to ruby_case
+      ruby_k = k.gsub(/([A-Z])/, '_\1').downcase
+      ruby_hash[ruby_k] = v
+    end
+    ruby_hash
+  end
+
+end

data/lib/lib/extensions/array_extensions.rb

@@ -0,0 +1,32 @@
+# Array extensions
+
+module ArrayExtensions
+  def to_f
+    epoch = DateTime.new(1970, 1, 1)
+    (self - epoch).to_f * 24 * 60 * 60  # DateTime deltas are in days
+  end
+
+  def to_str_arr
+    self.collect{|x| x.to_s}
+  end
+
+  def to_downcase_str_arr
+    self.collect{|x| x.to_s.downcase}
+  end
+
+  def to_i_arr
+    self.collect{|x| x.to_i}
+  end
+
+  def last_index(item)
+    self.length - 1 - self.reverse.index(item)
+  end
+
+  def rotate!(cnt=1)
+    cnt.times do
+      tmp = self.shift
+      self.push(tmp)
+    end
+    self
+  end
+end

data/lib/lib/extensions/datetime_extensions.rb

@@ -0,0 +1,8 @@
+# DateTime extensions
+
+module DateTimeExtensions
+  def to_f
+    epoch = DateTime.new(1970, 1, 1)
+    (self - epoch).to_f * 24 * 60 * 60  # DateTime deltas are in days
+  end
+end

data/lib/lib/extensions/extensions.rb

@@ -0,0 +1,51 @@
+require 'net/http'
+require 'date'
+require './lib/extensions/datetime_extensions'
+require './lib/extensions/float_extensions'
+require './lib/extensions/integer_extensions'
+require './lib/extensions/string_extensions'
+require './lib/extensions/nethttp_extensions'
+require './lib/extensions/array_extensions'
+require './lib/extensions/object_extensions'
+require './lib/extensions/file_extensions'
+
+class DateTime
+  prepend DateTimeExtensions
+end
+
+class Float
+  prepend FloatExtensions
+end
+
+class Integer
+  prepend IntegerExtensions
+end
+    
+class String
+  prepend StringExtensions
+end
+
+class Object
+  prepend ObjectExtensions
+end
+
+class Array
+  prepend ArrayExtensions
+end
+
+class Net::HTTP
+  alias _base_request request  # save base request
+
+  prepend NetHttpExtensions
+end
+
+=begin TODO: this causes infinite recursion. fix that if we want to use it.
+class File
+  # save base methods
+  alias _base_write write
+  alias _base_open open
+  alias _base_initialize initialize
+
+  prepend FileExtensions
+end
+=end

data/lib/lib/extensions/file_extensions.rb

@@ -0,0 +1,32 @@
+# File extensions
+
+module FileExtensions
+
+  def initialize(*args)
+    log_warn(__method__)
+    _base_initialize(*args)
+  end
+
+  def open(*args)
+    log_warn(__method__)
+    _base_open(*args)
+  end
+
+  def write(*args)
+    log_warn(__method__)
+    _base_write(*args)
+  end
+
+  private
+
+  def log_warn(meth)
+    if @_logger.nil?
+      @_logger = $logger
+    end
+    unless @_logger.nil?
+      @_logger.warn("File.#{meth}: reading/writing the TMC file system is not supported;" +
+                        ' please contact the TMC support team to discuss alternatives.')
+    end
+  end
+
+end

data/lib/lib/extensions/float_extensions.rb

@@ -0,0 +1,32 @@
+# Float extensions
+
+module FloatExtensions
+
+  # Public: Converts seconds to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def sec
+    (self * 1000).round
+  end
+
+  # Public: Converts minutes to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def min
+    sec * 60
+  end
+
+  # Public: Converts hours to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def hr
+    min * 60
+  end
+
+  # Public: Converts days to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def days
+    hr * 24
+  end
+end

data/lib/lib/extensions/integer_extensions.rb

@@ -0,0 +1,39 @@
+# Integer extensions
+
+module IntegerExtensions
+
+  # Public: Decorator for milliseconds.
+  #
+  # Returns the value.
+  def ms
+    self
+  end
+
+  # Public: Converts seconds to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def sec
+    self.to_f.sec
+  end
+
+  # Public: Converts minutes to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def min
+    self.to_f.min
+  end
+
+  # Public: Converts hours to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def hr
+    self.to_f.hr
+  end
+
+  # Public: Converts days to milliseconds.
+  #
+  # Returns the value in milliseconds.
+  def days
+    self.to_f.days
+  end
+end

data/lib/lib/extensions/nethttp_extensions.rb

@@ -0,0 +1,11 @@
+# Net::HTTP extensions
+
+module NetHttpExtensions
+
+  # Override request to add TMC-Application header for framework
+  def request(req, body = nil, &block)
+    req['TMC-Application'] = 'framework'
+    _base_request(req, body, &block)
+  end
+
+end

data/lib/lib/extensions/object_extensions.rb

@@ -0,0 +1,7 @@
+# Object extensions
+
+module ObjectExtensions
+  def not_nil?
+    !self.nil?
+  end
+end

data/lib/lib/extensions/string_extensions.rb

@@ -0,0 +1,35 @@
+# String extensions
+    
+module StringExtensions
+  #This method computes the substring similarity value and returns a number from 0-1.
+  def substring_similarity (text2)
+    test_case.get_substring_similarity(self, text2)
+  end
+  
+  #This method computes string similarity value and returns a number from 0-1.
+  def similarity (text2)
+    test_case.get_string_similarity(self, text2)
+  end
+
+  def to_arr(del=',')
+    self.split(del)
+  end
+
+  def to_str_arr(del=',')
+    self.split(del).collect{|x| x.to_s}
+  end
+
+  def to_downcase_str_arr(del=',')
+    self.split(del).collect{|x| x.to_s.downcase}
+  end
+
+  def to_i_arr(del=',')
+    self.split(del).collect{|x| x.to_i}
+  end
+
+  # Public: Converts a string to Time. String must be parseable by DateTime.parse.
+  def to_time
+    DateTime.parse(self).to_time
+  end
+
+end

data/lib/lib/helpers/tmc_helpers/csv_helper/csv_helper.rb

@@ -0,0 +1,85 @@
+require 'csv'
+
+class Csv
+  attr_reader(:rows)
+
+  # Public: Parses raw CSV data into a usable format.
+  #
+  # data   - String data to parse.
+  # header - Boolean indicating whether the data contains a header row (default: false).
+  #
+  # Returns a Csv instance.
+  def self.parse(data, args={})
+    Csv.new(data, args)
+  end
+
+  # Public: Converts the instance to a raw CSV string.
+  #
+  # Returns a String of CSV data.
+  def to_s
+    rows = @header.nil? ? [] : [@header]
+    rows += @rows.map {|obj| obj.values}
+    rows.map {|row| row.join(',')}.join("\n")
+  end
+
+  private
+
+  def initialize(data, args={})
+    rows = data.split(/\r?\n/).map {|row| row.split(',')}
+    if args.fetch(:header, false)
+      @header = rows.first
+      @rows = rows.drop(1).map {|row| Hash[row.map {|val| [@header[row.index(val)] || "_#{row.index(val)}", val]}]}
+    else
+      @header = nil
+      @rows = rows.map {|row| Hash[row.map {|val| [row.index(val), val]}]}
+    end
+  end
+end
+
+## Overwrite Ruby CSV library file in/out functions
+
+class CSV
+  def self.open(*args)
+    case args[1]
+    when "wb"
+      raise NoMethodError.new("Function disabled within TMC")
+    when "rb"
+      raise NoMethodError.new("Function disabled within TMC")
+    else
+      super
+    end
+  end
+end
+
+module CsvHelper
+  # Public: Used to ingest CSV string into array of arrays
+  # data  - String to be read
+  # options - You can set any reading preferences into the options hash Available options are:
+  # col_sep - The String placed between each field. This String will be transcoded into the data's Encoding before parsing.
+  # row_sep - The String appended to the end of each row. This can be set to the special :auto setting, which requests that CSV automatically discover this from the data.
+  # quote_char - The character used to quote fields. This has to be a single character String.
+  # field_size_limit - This is a maximum size CSV will read ahead looking for the closing quote for a field.
+  # converters - An Array of names from the Converters Hash and/or lambdas that handle custom conversion.
+  # unconverted_fields - If set to true, an unconverted_fields() method will be added to all returned rows (Array or CSV::Row) that will return the fields as they were before conversion. Note that :headers supplied by Array or String were not fields of the document and thus will have an empty Array attached.
+  # headers - If set to :first_row or true, the initial row of the CSV string will be treated as a row of headers. If set to an Array, the contents will be used as the headers. If set to a String, the String is run through a call of ::parse_line with the same :col_sep, :row_sep, and :quote_char as this instance to produce an Array of headers. This setting causes #shift to return rows as CSV::Row objects instead of Arrays and #read to return CSV::Table objects instead of an Array of Arrays
+  # return_headers - When false, header rows are silently swallowed. If set to true, header rows are returned in a CSV::Row object with identical headers and fields (save that the fields do not go through the converters).
+  # write_headers - When true and :headers is set, a header row will be added to the output.
+  # header_converters - Identical in functionality to :converters save that the conversions are only made to header rows.
+  # skip_blanks - When set to a true value, CSV will skip over any rows with no content.
+  # force_quotes - When set to a true value, CSV will quote all CSV fields it creates.
+  # skip_lines - When set to an object responding to match, every line matching it is considered a comment and ignored during parsing. When set to a String, it is first converted to a Regexp. When set to nil no line is considered a comment. If the passed object does not respond to match, ArgumentError is thrown.
+  # Returns an array of arrays
+  def csv_read(data, options={})
+    CSV.parse(data, options)
+  end
+
+  # Public: Parses raw CSV data into a usable format.
+  #
+  # data   - String data to parse.
+  # header - Boolean indicating whether the data contains a header row (default: false).
+  #
+  # Returns a Csv instance.
+  def csv_parse(data, args={})
+    Csv.parse(data, args)
+  end
+end